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

fix: use original anchor tags from the spec #287

Merged
merged 3 commits into from
Jun 24, 2021

Conversation

fmvilas
Copy link
Member

@fmvilas fmvilas commented Jun 24, 2021

Description

This PR makes it unnecessary to replace anchor tags like <a name="definitionsProducer"/> coming from the specification with something like {# definitionsProducer}. Therefore, no need for a preprocessing step when releasing a new version of the spec.

Related issue(s)
asyncapi/spec#536

@netlify
Copy link

netlify bot commented Jun 24, 2021

✔️ Deploy Preview for asyncapi-website ready!

🔨 Explore the source changes: 78cb4d8

🔍 Inspect the deploy log: https://app.netlify.com/sites/asyncapi-website/deploys/60d478c14886830008bb4215

😎 Browse the preview: https://deploy-preview-287--asyncapi-website.netlify.app

@derberg
Copy link
Member

derberg commented Jun 24, 2021

@fmvilas

We still have to somehow remove the ToC that's included in the original spec document.

this is already done by the automation on spec repo side, when updates to website are pushed

Comment on lines +1 to +2
# AsyncAPI Specification

Copy link
Member

@aayushmau5 aayushmau5 Jun 24, 2021

Choose a reason for hiding this comment

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

@derberg Now that the heading does not break the TOC, should we remove the automation that removes the heading?

Copy link
Member

Choose a reason for hiding this comment

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

yup, less custom actions on the spec is better

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.

there were some unrelated changes to the spec

pages/docs/specifications/v2.0.0.md Outdated Show resolved Hide resolved
pages/docs/specifications/v2.0.0.md Outdated Show resolved Hide resolved
pages/docs/specifications/v2.0.0.md Outdated Show resolved Hide resolved
@fmvilas
Copy link
Member Author

fmvilas commented Jun 24, 2021

Agree but I think they should be there. I'm just copy-pasting whatever was on the spec on tag v2.0.0. These fixes were done on the website and in the spec but they shouldn't have been done on the website.

@fmvilas
Copy link
Member Author

fmvilas commented Jun 24, 2021

I'm putting it back in the end. Don't want to be so picky.

@fmvilas fmvilas merged commit faf0f7f into asyncapi:master Jun 24, 2021
@fmvilas fmvilas deleted the fix-anchor-links-problem-with-spec branch June 24, 2021 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants