Skip to content

docs: configure for ubuntu.com proxy - #147

Closed
medubelko wants to merge 2 commits into
mainfrom
work/craft-5176-ubuntu.com-proxy
Closed

docs: configure for ubuntu.com proxy#147
medubelko wants to merge 2 commits into
mainfrom
work/craft-5176-ubuntu.com-proxy

Conversation

@medubelko

Copy link
Copy Markdown
Contributor

First attempt at the ubuntu.com proxy. We're doing Starflow in production to get a better sense of how much downtime is incurred.

It's possible to do this without committing overwrite-links.js directly, but since Starflow only has one version, it's simpler and more visible to track here.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Configures the Starflow documentation to be served via the ubuntu.com proxy at ubuntu.com/docs/starflow instead of the ReadTheDocs hosted URL, including a custom JS shim that rewrites links from the old domain to the new one.

Changes:

  • Update ogp_site_url and html_baseurl to the ubuntu.com proxy URL, and rename the sitemap to avoid collision with RTD's.
  • Add overwrite-links.js to rewrite header and RTD flyout links from documentation.ubuntu.com/starflow to ubuntu.com/docs/starflow.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/conf.py Switch canonical/OGP URL to the ubuntu.com proxy, rename sitemap, and load the new link-overwrite JS.
docs/_static/js/overwrite-links.js New client-side script that rewrites old-domain links in the header and RTD flyout.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/conf.py
Comment thread docs/conf.py
The trailing slash in `docs/starflow/` isn't present in the sitemap
otherwise.
@medubelko

Copy link
Copy Markdown
Contributor Author

@jahn-junior FYI: 840caf0

@medubelko

Copy link
Copy Markdown
Contributor Author

We're keeping Starflow on documentation.ubuntu.com for the time being. Closing.

@medubelko medubelko closed this Jul 2, 2026
@medubelko
medubelko deleted the work/craft-5176-ubuntu.com-proxy branch July 2, 2026 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants