adding readme extraction to provisional doc site

[CPTNB]

Signed-off-by: Brooke Green [email protected]

Description

This adds a simple script to traverse the repo and find all README.md files. It also adds a github action to run this script then push all the readme files to the provisional doc site. The mechanics for how this push happens are documented here. For this to be enabled on the main repo, we'll need to add a ssh private key as a deployment secret.

Check List

• [ ] New functionality includes testing.
  • [ ] All tests pass
    • [ ] yarn test:jest
    • [ ] yarn test:jest_integration
    • [ ] yarn test:ftr
• [ ] New functionality has been documented.
• [ ] Commits are signed per the DCO using --signoff

[ashwin-pc]

Looks like you have linting issues :p

[CPTNB]

I think it might be best since this is just provisional and informative right now to just not merge this and auto sync my fork nightly: https://stackoverflow.com/questions/23793062/can-forks-be-synced-automatically-in-github

I don't want to get into the situation where we have to like, get 2 ship-its on wiki doc content because it's in an official AWS repo.

[codecov-commenter]

Codecov Report

Merging #2095 (917a572) into main (2d6eef9) will decrease coverage by 0.00%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2095      +/-   ##
==========================================
- Coverage   67.22%   67.22%   -0.01%     
==========================================
  Files        3100     3100              
  Lines       59564    59565       +1     
  Branches     9062     9063       +1     
==========================================
  Hits        40043    40043              
+ Misses      17334    17308      -26     
- Partials     2187     2214      +27     

Impacted Files	Coverage Δ
...ore/public/chrome/ui/header/header_breadcrumbs.tsx	90.00% <0.00%> (-10.00%)	:arrow_down:
packages/osd-optimizer/src/node/cache.ts	50.00% <0.00%> (ø)
packages/osd-test/src/junit_report_path.ts	62.50% <0.00%> (ø)
packages/osd-optimizer/src/run_optimizer.ts	23.52% <0.00%> (ø)
src/core/public/chrome/ui/header/header.tsx	73.33% <0.00%> (ø)
packages/osd-optimizer/src/log_optimizer_state.ts	4.54% <0.00%> (ø)
...ckages/osd-optimizer/src/report_optimizer_stats.ts	21.42% <0.00%> (ø)
...s/osd-optimizer/src/node/node_auto_tranpilation.ts	83.67% <0.00%> (ø)
...est_runner/lib/docker_servers/container_running.ts	11.76% <0.00%> (ø)
...unner/lib/docker_servers/docker_servers_service.ts	28.98% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ashwin-pc]

@kavilla @CPTNB whats the next steps here? I am also against adding a workflow in OSD that pushes code to an unofficial repo. I'm okay with both the alternatives though:

1. Adding the workflow to the unoffical repo to trigger a sync nightly
2. Moving the unofficial repo to the opensearch-project org and pointing this workflow there.

[seanneumann]

Closing this as it's not an official change. We should discuss the better path.