-
-
Notifications
You must be signed in to change notification settings - Fork 100
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
feat: docs automation for website #1082
base: master
Are you sure you want to change the base?
feat: docs automation for website #1082
Conversation
https://github.com/asyncapi/extensions-catalog/blob/master/.github%2Fworkflows%2Fupdate-extensions-in-website.yml |
I'll take a look at it 👍 @sambhavgupta0705 btw, have a look at the following PR which is of similar nature and was used to push Glee docs to website: I took initial reference from here. Can you please explain me what's the difference between Lukasz's reference and your reference? |
the workflow I shared directly adds the link of the community to the |
we need to see if we need the increment of weights workflow for this workflow |
Got it. Let me work on that... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AnimeshKumar923 From what I understand the PR is setting up a workflow such that, on push to community docs in the community
repo, we want the changes to sync on the website(website
repo) which means the workflow should create a PR and get auto-merged.
I have already worked on similar automation workflow previously, you can check out the workflow here for reference.
cc @sambhavgupta0705 @alequetzalli
Thanks for the reference! 👍 @TRohit20 |
/au |
also, what docs will we be pushing onto the website? @alequetzalli @TRohit20 |
I'd suggest not to hard code the files we'd push on, use paths instead. Makes your file easier haha |
Question, @AnimeshKumar923, is this PR to replace the one I tried to make via #1064? I don't mind at all, if that is the case, I honestly still don't understand fully how to automate pushing our community docs to the website. If someone else such as yourself is making a PR to show me how to do so, please do share. 😅 Also, sorry but I do not fully understand the code. Can you walk me through it more? 🙏🏻 cc @TRohit20 |
Hey @alequetzalli sorry about that. I didn't see that PR as it wasn't linked in the original issue, hence I missed #1064 😅 If it's fine with you, I can help with the community docs automation through this PR. 😁 |
@alequetzalli Automation Workflow
|
@AnimeshKumar923 I will explain the whole workflow to you soon |
If I understood the issue correctly then this is how we approached it in glee:
|
Thank you for that extremely detailed walk-through of your code, @AnimeshKumar923!! I really appreciate it. 😀
Thank you, good question! We should push whatever is in the Does that make sense? lemme know ✌🏽 |
My pleasure! 😁
Yes, definitely. Thanks for the clarification! @alequetzalli |
@alequetzalli Thanks for sharing the notes. It will definitely help in the development process of this feature. 👍 I think for the modification in the docs structure, we should have separate PRs for better management and reviews. |
@AnimeshKumar923 Can you push the changes suggested and run the tests to check if it works as expected? |
@TRohit20 I'll do that. Please give me a bit more time. This week will be a bit hectic for me...😅 |
I will say that Animesh has proven to be a responsible contributor and he continues to be extremely responsive. We should be patient, cough cough @TRohit20 😛 😸 |
UPDATELukasz and I had a meet on Zoom. Here's the recording for reference and context if someone wants to watch it. Main points to focus:
cc: @TRohit20 here's the update... 😁 |
|
applied suggestion from: asyncapi#1082 (comment) Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
asyncapi#1082 (comment) Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
asyncapi#1082 (comment) Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
I've applied the suggestions and modified the workflow file accordingly. Please have a look @derberg @sambhavgupta0705 @TRohit20 I hope it will work as expected because locally it was behaving as expected when Lukasz was running it on his system. (Present in the recording) |
Looking forward to discussing this wild beast with you, @AnimeshKumar923 😄🐻 |
/au |
Description
Related issue(s)
Resolves #1028
Resolves #773