Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate Updating Github Wikis #4198

Merged
merged 8 commits into from
Nov 22, 2023
Merged

Conversation

chawinphat
Copy link
Contributor

@chawinphat chawinphat commented Nov 5, 2023

Description

Updates Github wiki automatically using github-wiki-action. This creates a new workflow that updates the github wiki.

What the new wiki looks like can be seen on my fork's repository.

Issues Resolved

Closes #3936

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@peterzhuamazon
Copy link
Member

Talked with @chawinphat in the office hour.
The link to files in main branch work as expected.
Awaiting @gaiksaya pointer on the next step.

Thanks.

wiki/Home.md Outdated Show resolved Hide resolved
wiki/Home.md Outdated Show resolved Hide resolved
.github/workflows/publish-wiki.yml Outdated Show resolved Hide resolved
.github/workflows/publish-wiki.yml Show resolved Hide resolved
Copy link

codecov bot commented Nov 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c438635) 93.29% compared to head (e999799) 93.16%.
Report is 23 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4198      +/-   ##
==========================================
- Coverage   93.29%   93.16%   -0.13%     
==========================================
  Files         187      189       +2     
  Lines        5802     5973     +171     
==========================================
+ Hits         5413     5565     +152     
- Misses        389      408      +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

chawinphat and others added 3 commits November 14, 2023 20:39
Co-authored-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Teddy T <[email protected]>
Co-authored-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Teddy T <[email protected]>
@chawinphat
Copy link
Contributor Author

@gaiksaya can you add @SachinSahu431 as a contributor to this PR somehow, as he was crucial in researching and implementing a prototype for this workflow.

Co-authored-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Teddy Tankuranand <[email protected]>
Copy link
Member

@gaiksaya gaiksaya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! This is a good start.

@gaiksaya gaiksaya merged commit 995ac9c into opensearch-project:main Nov 22, 2023
@gaiksaya
Copy link
Member

gaiksaya commented Nov 22, 2023

Hi @chawinphat

Looks like the workflow failed due to path: https://github.com/opensearch-project/opensearch-build/actions/runs/6961582353/workflow

path: The directory to use for your wiki contents. Default wiki/.

Need to specify the path as docs to the https://github.com/Andrew-Chen-Wang/github-wiki-action as input too.
Can you take this up as a follow up?
Thanks!

cc: @zelinh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation] Have a better documentation and way to update and maintain it regularly
3 participants