docs: [CT-3888] - Update API docs endpoint links to style matching linode/linode-docs-theme#400 #9691
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…node/linode-docs-theme#400
nmelehan
requested review from
hana-akamai and
carrillo-erik
and removed request for
a team
nmelehan
changed the title
jdamore-linode
added
Wait to Merge
Documentation
jdamore-linode
approved these changes
Sep 18, 2023
bnussman-akamai
approved these changes
Sep 18, 2023
carrillo-erik
approved these changes
Sep 18, 2023
hana-akamai
approved these changes
Sep 18, 2023
|
Closing due to inactivity. Feel free to reopen if linode/docs#6615 makes progress! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description 📝
https://github.com/linode/linode-docs-theme/pull/400 will update the API docs so that every endpoint is rendered to its own page, instead of an endpoint collection rendering all of its endpoints to a single page. URLs for API docs will change like so:
Before:
https://www.linode.com/docs/api/images/#image-upload
After:
https://www.linode.com/docs/api/images/image-upload/
This manager PR updates the one API docs link I could find that links to an individual endpoint within a collection.
Note that if a user visits one of the old-style anchor links for endpoint, there is client-side logic to refresh the page to show the new URL. This uses some JS to update the page's contents and the URL of the browser, instead of performing an actual page reload.
Please do not merge until we push the API docs changes to production.
Major Changes 🔄
Just the one URL change noted in the description
Preview 📷
No visual changes
How to test 🧪
Doesn't seem like testing is needed