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 Bug 🐞 report]: Correct the links of navigation buttons in Docs #1014

Closed
1 task done
akshatnema opened this issue Oct 11, 2022 · 7 comments · Fixed by #1020
Closed
1 task done

[Docs Bug 🐞 report]: Correct the links of navigation buttons in Docs #1014

akshatnema opened this issue Oct 11, 2022 · 7 comments · Fixed by #1020
Labels
🐞 docs bug good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com

Comments

@akshatnema
Copy link
Member

Describe the bug you found in AsyncAPI Docs.

Recently, I noticed that there are certain pages in the documentation which are connected wrongly with the adjacent/next pages in the UpNext and Previous buttons.

For ex: https://www.asyncapi.com/docs/tutorials/streetlights-interactive links the pages in a very different order as per the recent change and alignment of pages in docs. I would suggest refactoring the links inside each page related to these buttons in a correct manner so that we have a good synchronization with the pages inside the documentation. Overview pages of each section in Docs should also have these buttons, to connect the sequence of Docs.

Also, kindly change the route of UpNext button in https://www.asyncapi.com/docs/tutorials/getting-started page to /docs/tutorials/getting-started/event-driven-architecture

Attach any resources that can help us understand the issue.

This doesn't need any resources or tutorials as such. Just we have to change the links of each button on the respective doc pages

Code of Conduct

  • I agree to follow this project's Code of Conduct
@akshatnema akshatnema added 🐞 docs bug Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com good first issue Good for newcomers labels Oct 11, 2022
@manavdesai27
Copy link
Contributor

Could I work on this issue, I had already started working on issue #1000 . Work has already been done, it just needs approval, as I had already discussed it there, and started working accordingly. @akshatnema @derberg

@derberg
Copy link
Member

derberg commented Oct 12, 2022

@manavdesai27 definitely makes sense you continue with this one too as it is #1000 related.
I recommend you first start by researching what docs pages are missing Next/Prev buttons, and where they should point to when you add them. Show it here in a comment in a table, so we can easily verify and then you can open a PR.

Makes sense?

@manavdesai27
Copy link
Contributor

@manavdesai27 definitely makes sense you continue with this one too as it is #1000 related. I recommend you first start by researching what docs pages are missing Next/Prev buttons, and where they should point to when you add them. Show it here in a comment in a table, so we can easily verify and then you can open a PR.

Yeah sure, I will make a table and get it approved, and then will create a PR. @derberg

@manavdesai27
Copy link
Contributor

I have currently created the buttons and linked them in this manner, I wasn't sure where to link the Reference Overview page and thus have linked it to Specification v2.5.0. The current commits are according to the table, and once you approve it, I would create a PR. @derberg @akshatnema

Go Back Current Page Up Next
N/A Welcome Concepts-Overview
Welcome Concepts-Overview Server
Overview Server Producer
Server Producer Tutorials-Overview
Concepts-Producer Tutorials-Overview Getting Started-Introduction
Tutorials-Overview Introduction Event Driven Architectures
Getting Started-Introduction Event Driven Architectures Coming From OpenAPI
Event Driven Architectures Coming From OpenAPI Hello World
Coming From OpenAPI Hello World AsyncAPI Documents
Hello World AsyncAPI Documents Servers
AsyncAPI Documents Servers Adding Security
Servers Adding Security Streetlights - Interactive (Alpha)
Getting Started - Adding Security Streetlights - Interactive (Alpha) Streetlights
Streetlights - Interactive (Alpha) Streetlights Tools - Overview
Tutorials - Streetlights Tools - Overview Guides - Overview
Tools - Overview Guides - Overview Reference - Overview
Guides - Overview Reference - Overview Specification - v2.5.0

@derberg
Copy link
Member

derberg commented Oct 12, 2022

I think it looks good, @alequetzalli can you confirm please?

@manavdesai27
Copy link
Contributor

I see that /docs/reference/specification/latest redirects to the latest specification version page, and thus I think Reference-Overview's Up Next button should point to it. @derberg

@akshatnema
Copy link
Member Author

@manavdesai27 I checked the table on which you listed the sequence and it looks good to me. But yess, it now depends on @alequetzalli as well 😅. Regarding the Specification v2.5.0 page, it's better to link it via /docs/reference/specification/latest so as to get the latest specification on next page.

manavdesai27 added a commit to manavdesai27/website that referenced this issue Oct 13, 2022
quetzalliwrites added a commit that referenced this issue Oct 21, 2022
* Fix: Previous and UpNext Buttons

* Fix: Issue #1014

* Fix: Specification Redirection

* removing button from homepage

* needs line divisor

Co-authored-by: Alejandra Quetzalli <alejandra.olvera.novack@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐞 docs bug good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants