Skip to content

doc: update conf.py and add js for URL migration#1397

Draft
elijahgreenstein wants to merge 1 commit into
canonical:mainfrom
elijahgreenstein:migrate-main
Draft

doc: update conf.py and add js for URL migration#1397
elijahgreenstein wants to merge 1 commit into
canonical:mainfrom
elijahgreenstein:migrate-main

Conversation

@elijahgreenstein
Copy link
Copy Markdown
Contributor

These changes support migration of the documentation from documentation.ubuntu.com/microcloud to canonical.com/microcloud/docs:

  • Adds doc/_static/js/overwrite_links.js to properly handle links in the flyout menu (version selector).
  • Updates configuration settings in doc/conf.py
  • Reorganizes JavaScript files into doc/_static/js directory, and updates relevant paths

Checklist

These changes support migration of the documentation from
documentation.ubuntu.com/microcloud to canonical.com/microcloud/docs:

- Adds `doc/_static/js/overwrite_links.js` to properly handle links in
  the flyout menu (version selector).
- Updates configuration settings in `doc/conf.py`
- Reorganizes JavaScript files into `doc/_static/js` directory, and
  updates relevant paths

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
@github-actions github-actions Bot added the Documentation Documentation needs updating label Jun 2, 2026
Copy link
Copy Markdown
Contributor

@roosterfish roosterfish left a comment

Choose a reason for hiding this comment

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

LGTM, ready when you give the green light :)

Comment thread doc/_static/js/overwrite_links.js
@roosterfish
Copy link
Copy Markdown
Contributor

Should we start with this one first, or do we have to merge all of them at around the same time as we switch "all" the docs from ubuntu.com to canonical.com?

@elijahgreenstein
Copy link
Copy Markdown
Contributor Author

Once we get the go ahead, we should merge both of the MicroCloud updates around the same time, so that the entire MicroCloud doc set is moved to canonical.com at once. This does not need to be synced with the LXD docs, however, which can moved at a different time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants