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]: Remove v2 spec links for v3 #1855

Closed
jonaslagoni opened this issue Jun 28, 2023 · 14 comments
Closed

[📑 Docs]: Remove v2 spec links for v3 #1855

jonaslagoni opened this issue Jun 28, 2023 · 14 comments
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers

Comments

@jonaslagoni
Copy link
Member

For AsyncAPI v3, we need to remove all the links to the other v2 spec documents so only v3 and onwards are visible (https://www.asyncapi.com/docs/reference).

Make sure you base your change on the next-major-spec branch and target it in your PR 🙂 If you have any questions, don't hesitate to ask.

@jonaslagoni
Copy link
Member Author

@derberg I actually dont have enough information to make this a good first issue. Can you help define what needs to be adapted here?

@derberg
Copy link
Member

derberg commented Jun 28, 2023

what do you mean, just files need to be removed, just like you did it for the other docs that you removed already

@derberg
Copy link
Member

derberg commented Jun 28, 2023

and redirects cleaned up - https://github.com/asyncapi/website/blob/master/public/_redirects

probably instead of removing, we just just make sure they point to v2.asyncapi.com

@jonaslagoni
Copy link
Member Author

jonaslagoni commented Jun 28, 2023

@derberg but dont we have automation scripts that might push old docs to the website?

and redirects cleaned up - https://github.com/asyncapi/website/blob/master/public/_redirects

What exact redirects is needed?

probably instead of removing, we just just make sure they point to v2.asyncapi.com

Thats a very non-good first issue description 😆

@jonaslagoni
Copy link
Member Author

Soo the following tasks list makes sense to you?

  • Remove all v2 docs from pages/docs/reference/specification
  • Setup redirects for all the removed v2 documents, so they point to v2.asyncapi.com
  • Manually add link to v2 documents in the list of references (however that is done)

Copy link
Member

derberg commented Jun 28, 2023

@derberg but dont we have automation scripts that might push old docs to the website?

yes, but it manages latest, not old. And would be nice to have redirects for v2 spec docs that will take someone from https://www.asyncapi.com/docs/reference/specification/v2.6.0 that do not exist, to https://v2.asyncapi.com/docs/reference/specification/v2.6.0

Thats a very non-good first issue description

well probably it is not a good first issue 😛

Remove all v2 docs from pages/docs/reference/specification

yup

Setup redirects for all the removed v2 documents, so they point to v2.asyncapi.com

yes

Manually add link to v2 documents in the list of references (however that is done)

don't know what you mean

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jun 29, 2023

/good-first-issue area/docs

@asyncapi-bot asyncapi-bot added area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. good first issue Good for newcomers labels Jun 29, 2023
@quetzalliwrites
Copy link
Member

/docs

@quetzalliwrites
Copy link
Member

failing at adding the docs label with the bot @derberg 🤔

@derberg
Copy link
Member

derberg commented Jun 29, 2023

you can always do /help to get description on how to use it. In short, do not write area/docs but just docs

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Oct 31, 2023
@AbhishekCS3459
Copy link
Contributor

I want to work on this issue please assign it to me.

@derberg
Copy link
Member

derberg commented Oct 31, 2023

@AbhishekCS3459 it is already work in progress -> #2281

@github-actions github-actions bot removed the stale label Nov 1, 2023
@derberg
Copy link
Member

derberg commented Nov 8, 2023

done with #2281

@derberg derberg closed this as completed Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers
Projects
Status: Changes proposed 📄
Development

No branches or pull requests

5 participants