-
-
Notifications
You must be signed in to change notification settings - Fork 696
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
Remove spec docs duplication #86
Comments
I guess you meant https://www.asyncapi.com/docs/specifications/latest, right? it's currently being redirected here: https://github.com/asyncapi/website/blob/master/public/_redirects#L8. Also, let's make sure it never redirects using 301 because this will make the redirect permanent and will be cached by browsers.
a google? 🤔 |
toggle, drop down, come version chooser component 😛
right, updated, thanks. I also think https://www.asyncapi.com/docs/specifications should redirect to latest |
I would like to work on this.(Just commenting here for the Issue) |
just for your information, I realized we do not need a feature toggle as we have left nav anyway and all specs will be listed there, so no need to add additional navigation element - toggle |
this is fixed by @aayushmau5 now |
I guess, we should close this issue now. :D |
Reason/Context
With specification, we have at the moment the following situation.
1 https://github.com/asyncapi/spec/blob/2.0.0/versions/2.0.0/asyncapi.md is the location of official specification
2 https://github.com/asyncapi/spec/blob/2021-06-release/spec/asyncapi.md is the candidate for next release
3 https://github.com/asyncapi/website/blob/master/pages/docs/specifications/2.0.0.md 2.0 spec duplicate that should not be edited in website but automatically updated from spec repo
Description
In short, on every release in spec (no matter if official or pre-release) update website through PR so after automerge it is automatically published.
not in scope
Automation of spec release. The creation of GitHub releases for latest and candidates. Just assume it will be in place, so automation from this task should be based on GitHub
release
event. How you can tell that release is a release candidate? it is marked asPre-release
and the release tag will look something likev2.1.0-2021-06-release.1
(some example from another project https://github.com/asyncapi/asyncapi-react/releases/tag/v1.0.0-next.2)Website repo
Edit this page on Github
should not take you towebsite
but tospec
repository where spec is located and actually ug fixes can be suggestedSpec repo
spec
repo intowebsite
? I suggestpush
approach rather thenpull
. In other words,spec
repo pushes changes towebsite
repo instead ofwebsite
repo pulling for changes fromspec
. We need GitHub Action workflow that would be triggered on everyrelease
, it would pick up changes either frommaster
(in case of official release when tag is createdor from the release branch (in case there is a pre-release). In the workflow you would need to pull
website`, add proper files there and then open a PR using proper GH action. Auto approve and merge is already in place, because you will use asyncapi bot here.hints
The text was updated successfully, but these errors were encountered: