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

docs: add workflow to push community docs to live website #1064

Closed

Conversation

quetzalliwrites
Copy link
Member

We need to add a workflow to the community repo too for pushing new docs merged in this repo to our live website.

I'm not sure if this is correct, so I look forward to feedback 😅 🙏🏻 .

cc @KhudaDad414 @smoya @fmvilas @derberg @akshatnema

@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Feb 13, 2024
@quetzalliwrites quetzalliwrites self-assigned this Feb 13, 2024
@smoya
Copy link
Member

smoya commented Feb 13, 2024

@alequetzalli I guess you first need a section in the website where you want this docs to be shown.
I have no idea regarding how to upload docs to the website from a different repo. Maybe @akshatnema may help with both things.

@derberg
Copy link
Member

derberg commented Feb 13, 2024

you can remove the workflow you add through this PR as it is global one. I just added get-global-docs-autoupdate topic to this repo and we have latest version of this workflow now -> https://github.com/asyncapi/community/pull/1066/files

but this is not website update related workflow, it is cool for triggering autoupdates if there is TOC in readme that needs to be update or stuff like that.

what you need to do in this PR to get website docs automation are 2 things:

  • have a workflow that actually push code to website and adds there some basic configuration. Best inspiration is in https://github.com/asyncapi/extensions-catalog/blob/master/.github/workflows/update-extensions-in-website.yml workflow that handles all cases - you just need to of course change any references from extensions to community
  • you need to adjust the structure of docs folder but first manually check what needs to be adjusted. You basically need to open a PR to website repo that will never be merged - like https://github.com/asyncapi/website/pull/2287/files and thanks to it you will be able to basically see, where markdown files need to be placed in the repo, if front matter is correct, if links work - to make sure all GH links are absolute not relative. Things like that. Basically first time you do it, website PR approach is necessary so you can get a preview of how docs will look in website

Then remove _section.md that is created by automation script and update whatever markdown changes you need basing on your finding from website PR

I hope that helps

@quetzalliwrites
Copy link
Member Author

Thank you @derberg for all the details. I am still processing all that information, so I will follow up with questions soon 😸

@quetzalliwrites
Copy link
Member Author

@AnimeshKumar923 can I close this PR ? I believe you told me so, but I wanted to double check 👍🏻

@AnimeshKumar923
Copy link
Contributor

AnimeshKumar923 commented Mar 13, 2024

@AnimeshKumar923 can I close this PR ? I believe you told me so, but I wanted to double check 👍🏻

@alequetzalli Yes, it's safe to close this. We'll be carrying this forward in #1082
Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants