Move API content to the new toplevel API section, link the TopNav and light it up in the search - #3439
Open
borland wants to merge 8 commits into
Open
Move API content to the new toplevel API section, link the TopNav and light it up in the search#3439borland wants to merge 8 commits into
borland wants to merge 8 commits into
Conversation
borland
force-pushed
the
orion/move-api
branch
from
September 1, 2026 12:30
7b870bb to
f64ede8
Compare
borland
requested review from
steve-fenton-octopus and
tonykelly-octopus
as code owners
September 1, 2026 12:30
|
Pull request environment is available at https://stoctodocspr3439.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
steve-fenton-octopus
requested review from
KMajkrzakOctopus
and removed request for
steve-fenton-octopus
September 1, 2026 14:07
This file contains hidden or 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
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.
Our new UI design intends for all the API-related docs to go under /docs/api, and be accessible via an "API" button in the top-level nav bar. The API docs also include generated docs, synced from the Octopus Server repository on a regular basis.
These generated docs were already present but not linked anywhere. This PR finishes the job, as follows
The top-nav "API" button now goes to
/docs/apiPages that were previously inside the
/docs/octopus-rest-apifolder have now moved to/docs/apiFixed all the links from
/docs/octopus-rest-api/**to now go to/docs/api/**Redirects have been installed for
/docs/octopus-rest-apiso external links pointing to the old URL's should still workThe "under construction" code has been removed, so the pagefind search index should now include generated API docs. Including change to the "Facet" thing
Reducing Risk
I've tested locally, but will re-test properly on the staging site (will check off as I've done)
apiHit some old
octopus-rest-api/links and check they redirect to the correct new URLdocs/octopus-rest-api/octopus.clientdocs/octopus-rest-api/examples/artifactsdocs/octopus-rest-api/openid-connectRedirects are annoying to test on the staging site as the redirects hardcode links to octopus.com/docs which won't be valid until this PR merges. But if you take the
/docs/api/...whateverpart of the URL from the redirect and check it on the staging site, it's goodPlease bash at it and do whatever you think might be worth testing