ci: glee docs automation workflow #548
Conversation
Changes: - Made the changes to be in accordance of the glee repository. - Can be modified later according to the feedbacks.
AnimeshKumar923
requested review from
fmvilas,
Souvikns,
KhudaDad414 and
asyncapi-bot-eve
as code owners
|
@afzal442 can you please review this once? |
| @@ -0,0 +1,50 @@ | |||
| name: Update latest Glee documentation in the website | |||
There was a problem hiding this comment.
the workflow and script looks good.
but did anyone try to first check manually if this is enough? Website docs will not just digest what you send that easily out of the box. I quickly looked into your docs dir and noticed:
- you have subfolders
- you have no front matters in markdown files, like title/weights in https://github.com/asyncapi/cli/blob/master/docs/context.md
My recommendation, try to do the same that you do here in the workflow, manually on a website, and see if your docs will render. I would suggest a prerequisite for this PR is to have a draft PR on website that showcases that after merging this PR it will work like a charm
There was a problem hiding this comment.
sure, I will be doing this part. Thanks
There was a problem hiding this comment.
@afzal442 Thanks! 👍 🚀
There was a problem hiding this comment.
you have no front matters in markdown files
sorry @derberg I forgot to tell you about that is you could find those on /docs/pages/* folder.
There was a problem hiding this comment.
moreover, this PR is up to migrate those remaining pages to /pages/ folder. Hope that makes sense now
There was a problem hiding this comment.
folks, you can now add get-global-docs-autoupdate topic to this repo, and ask @KhudaDad414 to run https://github.com/asyncapi/.github/actions/workflows/global-replicator.yml against this repo
Changes: - add suggestion from asyncapi#548 (comment) Co-authored-by: Afzal Ansari <[email protected]>
Changes: - deleted this workflow because as told by Lukasz because it will be centrally managed in .github repo by asyncapi/.github#242
Thank you! 🙏 |
|
Kudos, SonarCloud Quality Gate passed!
|
|
thanks for the contribution @AnimeshKumar923 and @afzal442 . I am merging this PR now. |
KhudaDad414
changed the title
@KhudaDad414 Happy to help! 😁 |
|
/rtm |
|
🎉 This PR is included in version 0.28.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
This PR adds the necessary workflows required to automate the process of updating Glee docs in the main website.
Related issue(s)
Fixes #481