feat: cleanup reference docs for 3.0

[derberg]

this is related to v3, what will be visible to people on asyncapi.com after release

• removing v2 specs
• leaving out 2.x in navigation with short memo
• updating redirects so people will not have dead links to v2 specs

resolves #1855

[netlify]

✅ Deploy Preview for shimmering-choux-eb0798 ready!

Name	Link
🔨 Latest commit	526e135
🔍 Latest deploy log	https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/653ff1a879bf960008114945
😎 Deploy Preview	https://deploy-preview-2281--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[derberg]

@BhaswatiRoy @TRohit20 once this is merged, you can update links to specification in your PRs. @alequetzalli not sure who else needs this memo

so basically, maybe only in concept docs 🤔 , sometimes you wanna link to some section in spec reference docs.

till now contributors had to provide links that contained 3.0.0-next-major-spec.12 (that would stop working after release) or v3.asyncapi.com (that would stop working after release)

now redirects are updated so you can already in your docs PRs add relative links with latest keyword. These will work nicely in previews.

so let's imagine you write Server document like https://deploy-preview-2281--shimmering-choux-eb0798.netlify.app/docs/concepts/server and you want to link for more info to Servers Object from spec document https://deploy-preview-2281--shimmering-choux-eb0798.netlify.app/docs/reference/specification/v3.0.0#serversObject your markdown link code should point to /docs/reference/specification/latest#serversObject so something like:

[Servers Object](/docs/reference/specification/latest#serversObject)

[quetzalliwrites]

@BhaswatiRoy @TRohit20 once this is merged, you can update links to specification in your PRs. @alequetzalli not sure who else needs this memo

so basically, maybe only in concept docs 🤔 , sometimes you wanna link to some section in spec reference docs.

till now contributors had to provide links that contained 3.0.0-next-major-spec.12 (that would stop working after release) or v3.asyncapi.com (that would stop working after release)

now redirects are updated so you can already in your docs PRs add relative links with latest keyword. These will work nicely in previews.

so let's imagine you write Server document like https://deploy-preview-2281--shimmering-choux-eb0798.netlify.app/docs/concepts/server and you want to link for more info to Servers Object from spec document https://deploy-preview-2281--shimmering-choux-eb0798.netlify.app/docs/reference/specification/v3.0.0#serversObject your markdown link code should point to /docs/reference/specification/latest#serversObject so something like:

[Servers Object](/docs/reference/specification/latest#serversObject)

FYI folks, make sure you are aware of these changes described above by Lukaszzzz...

• Vaishnavi @VaishnaviNandakumar
• Mahfuza @mhmohona
• Bhaswati @BhaswatiRoy
• Cynthia Peter @CynthiaPeter
• Arya Gupta @Arya-Gupta
• Joy Almeida @J0SAL
• Hridyesh @kakabisht
• Rohit @TRohit20

[quetzalliwrites]

LGTM 🪄

[akshatnema]

@derberg are we prepared with subdomains like v2.asyncapi.com, v1.asyncapi.com for v1 and v2 version of docs?

[derberg]

@akshatnema no need for v1, this is old history. Few days before the release date we cut current master and turn into v2, and then next-major-spec is merged and becomes asyncapi.com and we remove v3

[akshatnema]

So are we now targeting feature branches for docs versioning?

[derberg]

So are we now targeting feature branches for docs versioning?

@akshatnema sorry?

[akshatnema]

@akshatnema sorry?

I mean, are we are not deploying website with different branches, as different versions of docs will be present in repo?

[derberg]

@akshatnema are you asking now or after release?

now we deploy

• asyncapi.com from master
• v3.asyncapi.com from next-major-spec

after v3 release

• we create v2 branch from master (probably 2 weeks before release) and start deploying v2.asyncapi.com forever
• next-major-spec goes to master and whatever was v3.asyncapi.com becomes asyncapi.com

[akshatnema]

@akshatnema are you asking now or after release?

Yes, and I understand what you are trying to do.

[derberg]

/rtm