Allow self-hosting of custom site-specific user and operator documentation #200
+139
−27
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
sd109
commented
Jan 8, 2025
| @@ -3,7 +3,7 @@ | |||
| collections: | |||
| - name: https://github.com/azimuth-cloud/ansible-collection-azimuth-ops.git | |||
| type: git | |||
| version: 0.13.2 | |||
| version: feat/mkdocs # 0.13.2 | |||
There was a problem hiding this comment.
TODO: Revert this before merging.
MoteHue
reviewed
Jan 9, 2025
| As part of the standard Azimuth deployment procedure, a copy of the generic user and operator | ||
| documentation sites are published on separate subdomains of the Azimuth ingress URL. For an Azimuth | ||
| instance hosted at `portal.azimuth.example.com`, the documentation can be accessed at | ||
| `user.docs.azimuth.example.com` and `admin.docs.azimuth.example.com` respectively. The operator |
There was a problem hiding this comment.
Would it make sense to use operator.docs.azimuth.example.com instead of admin.docs.azimuth.example.com? Would match how it's being referred to in this section.
There was a problem hiding this comment.
Yeah probably, I flip-flopped between admin and operator a few times while putting this together. I guess we should settle on one or the other for consistency before finalising the changes.
There was a problem hiding this comment.
I fact, that's a mistake in the docs because I also changed my mind and went for user-guide and admin-guide as the subdomains after writing those docs 🤦
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.
This PR adds the ability to build and publish the Azimuth user documentation on a subdomain of the main Azimuth URL.
It depends on azimuth-cloud/ansible-collection-azimuth-ops#732 which in turn makes use of https://github.com/azimuth-cloud/mkdocs-helm to build and publish the documentation sites.