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

ci: updating spec urls to match new Information Architecture in website #801

Conversation

alequetzalli
Copy link
Member

@alequetzalli alequetzalli commented May 26, 2022


title: "updating spec urls to match new Information Architecture changes via asyncapi/website#601"

301 updates due to GSoD IA changes


Related issue(s):
asyncapi/website#601


Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link
Member

@fmvilas fmvilas left a comment

Choose a reason for hiding this comment

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

Wouldn't it break existing links pointing to the old URL? If so, please let's add redirects from the old URL to the new one.

@alequetzalli
Copy link
Member Author

Wouldn't it break existing links pointing to the old URL? If so, please let's add redirects from the old URL to the new one.

@fmvilas that work is in PR 601 which is mentioned here 😜

@derberg
Copy link
Member

derberg commented Jun 9, 2022

@fmvilas that work is in PR 601 which is mentioned here 😜

@fmvilas

Let's say new release is 2.5. After changes from @alequetzalli, we get below
/docs/reference/specification/latest /docs/reference/specification/v2.5.0 302!

It is performed as "addition", not "override", it is added on top of the list

@alequetzalli so this PR is good, but you need more updates in PR on website.

this 👇🏼

# SPEC-REDIRECTION:START
/docs/specifications/2.4.0 /docs/specifications/v2.4.0 302!
/docs/specifications/2.3.0 /docs/specifications/v2.3.0 302!
/docs/specifications/2.2.0 /docs/specifications/v2.2.0 302!
/docs/specifications/2.1.0 /docs/specifications/v2.1.0 302!
/docs/specifications/2.0.0 /docs/specifications/v2.0.0 302! # The path was changed. We want to keep links pointing to the old path working.
# SPEC-REDIRECTION:END

must be 👇🏼

# SPEC-REDIRECTION:START
/docs/specifications/2.4.0 /docs/reference/specification/v2.4.0 302!
/docs/specifications/2.3.0 /docs/reference/specification/v2.3.0 302!
/docs/specifications/2.2.0 /docs/reference/specification/v2.2.0 302!
/docs/specifications/2.1.0 /docs/reference/specification/v2.1.0 302!
/docs/specifications/2.0.0 /docs/reference/specification/v2.0.0 302!
/docs/specifications/v2.4.0 /docs/reference/specification/v2.4.0 302!
/docs/specifications/v2.3.0 /docs/reference/specification/v2.3.0 302!
/docs/specifications/v2.2.0 /docs/reference/specification/v2.2.0 302!
/docs/specifications/v2.1.0 /docs/reference/specification/v2.1.0 302!
/docs/specifications/v2.0.0 /docs/reference/specification/v2.0.0 302!
# SPEC-REDIRECTION:END

so in future releases, after 2.5 it looks like👇🏼

# SPEC-REDIRECTION:START
/docs/reference/specification/2.5.0 /docs/reference/specification/v2.5.0 302!
/docs/specifications/2.4.0 /docs/reference/specification/v2.4.0 302!
/docs/specifications/2.3.0 /docs/reference/specification/v2.3.0 302!
/docs/specifications/2.2.0 /docs/reference/specification/v2.2.0 302!
/docs/specifications/2.1.0 /docs/reference/specification/v2.1.0 302!
/docs/specifications/2.0.0 /docs/reference/specification/v2.0.0 302!
/docs/specifications/v2.4.0 /docs/reference/specification/v2.4.0 302!
/docs/specifications/v2.3.0 /docs/reference/specification/v2.3.0 302!
/docs/specifications/v2.2.0 /docs/reference/specification/v2.2.0 302!
/docs/specifications/v2.1.0 /docs/reference/specification/v2.1.0 302!
/docs/specifications/v2.0.0 /docs/reference/specification/v2.0.0 302!
# SPEC-REDIRECTION:END

I hope this makes sense 😅

@fmvilas
Copy link
Member

fmvilas commented Jun 9, 2022

Oh sorry, I saw the response from Ale and forgot to reply 😓 Yeah, I'm fine with it 👍

fmvilas
fmvilas previously approved these changes Jun 9, 2022
@magicmatatjahu
Copy link
Member

We need also update .github/scripts/remove-toc.js and .github/workflows/update-spec.yaml files.

@alequetzalli
Copy link
Member Author

We need also update .github/scripts/remove-toc.js and .github/workflows/update-spec.yaml files.

@magicmatatjahu Why do I need to update the toc file in this?

The toc changes you are working on have nothing to do with this PR. TOC updates are not IA related.

@alequetzalli
Copy link
Member Author

alequetzalli commented Jun 10, 2022

I hope this makes sense 😅

Great feedback, thank you @derberg! I will reach out if I get confused

@magicmatatjahu
Copy link
Member

@alequetzalli because that script removes TOC from spec files, so you need also update that script as well .github/workflows/update-spec.yaml. We have two workflows:

  • when we release new version of spec
  • when we update existing one

and it and it we need to remove TOC, but from markdown. Please check these files and you will see that there are also docs/specifications mentions :)

https://github.com/asyncapi/spec/blob/master/.github/scripts/remove-toc.js#L12
https://github.com/asyncapi/spec/blob/master/.github/workflows/update-spec.yaml#L44

@alequetzalli
Copy link
Member Author

@magicmatatjahu Ah! I think I follow you now... Thanks for the detailed specifics and I'll let you know if I need more help

@derberg
Copy link
Member

derberg commented Jun 13, 2022

@magicmatatjahu good catch!

@magicmatatjahu
Copy link
Member

magicmatatjahu commented Jun 13, 2022

@derberg thanks! I have a question, because @derberg you added a comment about redirects (here #801 (comment)) and I wonder if we need to change the script to produce 2 redirects for each spec, for docs/specifications/... and docs/reference/specification/..., or only have old redirects for docs/specifications/... and for new spec no. What do you think?

@derberg
Copy link
Member

derberg commented Jun 13, 2022

@magicmatatjahu yeah, I suggested it this way intentionally. Keep old, but for new, not.

@sonarcloud
Copy link

sonarcloud bot commented Jun 13, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@alequetzalli
Copy link
Member Author

@magicmatatjahu Let me know if I followed all your instructions correctly! This PR is ready for review again 😸

cc @derberg

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

Should be merged after asyncapi/website#601

@alequetzalli
Copy link
Member Author

Should be merged after asyncapi/website#601

We'll have you merge them right @derberg? I assumed it made the most sense for you to be the maintainer to merge both when ready.

@derberg
Copy link
Member

derberg commented Jun 14, 2022

@alequetzalli definitely! good assumption 😄

@derberg derberg changed the title feat: updating spec urls to match new Information Architecture changes via /website PR #601 ci: updating spec urls to match new Information Architecture in website Jun 14, 2022
@derberg
Copy link
Member

derberg commented Jun 15, 2022

/rtm

@asyncapi-bot asyncapi-bot merged commit 70d0d67 into asyncapi:master Jun 15, 2022
fmvilas pushed a commit to fmvilas/spec that referenced this pull request Jun 15, 2022
fmvilas added a commit that referenced this pull request Jun 15, 2022
* feat: merge with latest master

* ci: updating spec urls to match new Information Architecture in website (#801)

* docs: fix links in Markdown files (#769)

Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com>
Co-authored-by: Khuda Dad Nomani <32505158+KhudaDad414@users.noreply.github.com>
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.5.0-next-major-spec.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@fmvilas
Copy link
Member

fmvilas commented Sep 22, 2022

Forget about the last comment saying it was released in version 2.5.0-next-major-spec.1. I made a mistake and it created this version but it should actually be 3.0.0-next-major-spec.1. There's a notice in the release. Apologies for the noise.

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.5.0-next-spec.5 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@derberg
Copy link
Member

derberg commented Jan 31, 2023

Recent comments about the release from the bot were added by mistake. More details in #899

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.

None yet

5 participants