-
-
Notifications
You must be signed in to change notification settings - Fork 983
docs: add guide for managing short URLs on AsyncAPI website #4491
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
Changes from 3 commits
a2e872b
1dc1e84
d5febd6
11c75cc
8cef85b
5565a34
e70cb0a
c5b76fb
34f1530
568a820
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -218,6 +218,79 @@ Once you collect all information and create a case study, open a pull request. I | |||||
|
|
||||||
| A case study becomes publicly available right after merging and rebuilding the website. | ||||||
|
|
||||||
| # 🌐 Adding Short URLs to the AsyncAPI Website | ||||||
|
||||||
|
|
||||||
| The AsyncAPI website supports **short URLs** through Netlify's redirect system using the `public/_redirects` file. | ||||||
| This feature enables the creation of memorable, easy-to-share links that redirect to longer URLs — improving user experience and making resources more accessible for the community. | ||||||
|
|
||||||
| Short URLs are useful for: | ||||||
| - Community resources (Slack, GitHub) | ||||||
| - Frequently accessed documentation | ||||||
| - Marketing campaigns and events | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## ⚙️ How It Works | ||||||
|
|
||||||
| All redirects are defined in the `public/_redirects` file. This file follows **Netlify’s redirect syntax** and is automatically processed during deployment. | ||||||
|
|
||||||
| ### Existing Examples | ||||||
|
|
||||||
| | Short URL | Redirects To | Type | | ||||||
| |------------|---------------|------| | ||||||
| | `/slack-invite` | Slack invitation link | Temporary (302) | | ||||||
| | `/modelina` | `/tools/modelina` | Permanent (301) | | ||||||
| | `/generator` | `/tools/generator` | Permanent (301) | | ||||||
| | `/cheatsheet` | GitHub cheatsheet | Permanent (301) | | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## ✅ When to Create a Short URL | ||||||
|
|
||||||
| - **Community resources:** Slack, GitHub repositories | ||||||
| - **Frequently accessed tools:** AsyncAPI Studio, Generator, Modelina | ||||||
| - **Docs shortcuts:** Specification, Getting Started, Tutorials | ||||||
| - **Events & campaigns:** Conferences | ||||||
|
|
||||||
| ### Avoid Short URLs For | ||||||
|
|
||||||
| - Frequently changing internal pages | ||||||
| - Temporary content without clear end dates | ||||||
| - URLs that conflict with existing site routes | ||||||
| - Personal or private organization links | ||||||
| - Already short, self-explanatory URLs | ||||||
|
||||||
|
|
||||||
| --- | ||||||
|
||||||
| --- |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see naming conventions below
Where? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was above not below 😅
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 3. **Select the correct redirect type** — permanent (301) or temporary (302). | |
| 3. **Select the appropriate redirect type**, for example, permanent (301) or temporary (302). |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some examples would be helpful here
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 2. Add **context in the PR description** — why this short URL is needed. | |
| 2. Add **context in the PR description** describing why this short URL is needed. |
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have staging env?
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it mean that the author of a new short url will forever be its maintainer?
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section should be a part of the step 2 of the guide above
Uh oh!
There was an error while loading. Please reload this page.