Skip to content

Conversation

@MaxBed4d
Copy link
Contributor

No description provided.

Copy link
Contributor

@sd109 sd109 left a comment

Choose a reason for hiding this comment

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

Nice work @MaxBed4d - thanks for making a start on this! In general I'd like to avoid making these docs specific to SKC wherever possible so I've left a few comments about that in various places. I've also suggested a few corrections on things which aren't necessarily applicable to standalone CAPI management clusters.

@MaxBed4d
Copy link
Contributor Author

This config should now also include an updated web UI for the docs. It has been tested locally and all the formatting looks to be working correctly.

@MaxBed4d MaxBed4d force-pushed the magnum-docs branch 2 times, most recently from c81b8d1 to 987cbb8 Compare October 24, 2025 15:21
@MaxBed4d MaxBed4d marked this pull request as ready for review October 29, 2025 13:22
@JohnGarbutt
Copy link
Contributor

When we last discussed this in platforms, granted a few years back, we were worried on how we maintain these and keep them in-sync with the Azimuth docs.

I don't disagree we need these, but I am hoping we can make it DRY-er vs the existing Azimuth docs.

Copy link
Contributor

@JohnGarbutt JohnGarbutt left a comment

Choose a reason for hiding this comment

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

Most of my comments are very small niggles, this is looking pretty good.

I do worry about the resource constraints section... its a very "it depends" sort of a question.

Copy link
Contributor

@sd109 sd109 left a comment

Choose a reason for hiding this comment

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

Thanks Max, looking like it's getting better for sure. A few suggestions from me.

MaxBed4d and others added 2 commits November 17, 2025 10:53
@MaxBed4d MaxBed4d requested a review from sd109 November 18, 2025 13:45
@sd109
Copy link
Contributor

sd109 commented Dec 10, 2025

@MaxBed4d having taken a step back and looked at the newly added documentation sections, I agree with @JohnGarbutt that there's far too much repetition which will make maintenance and keeping the documentation up to date more difficult than it should be.

I've pushed a modified version of your docs in the latest commit which condenses them down to a single page and focuses much more on what's different in the CAPI-only case while clearly linking to the main Azimuth documentation when relevant rather than repeating information which is already present in the main docs. Let me know what you think or if you feel that I've missed anything important.

@sd109 sd109 changed the title Add documentation for CAPI Management Cluster Add documentation for standalone CAPI Management Cluster Dec 10, 2025
@MaxBed4d
Copy link
Contributor Author

@MaxBed4d having taken a step back and looked at the newly added documentation sections, I agree with @JohnGarbutt that there's far too much repetition which will make maintenance and keeping the documentation up to date more difficult than it should be.

I've pushed a modified version of your docs in the latest commit which condenses them down to a single page and focuses much more on what's different in the CAPI-only case while clearly linking to the main Azimuth documentation when relevant rather than repeating information which is already present in the main docs. Let me know what you think or if you feel that I've missed anything important.

Looks good @sd109, I have made a few minor grammatical changes, but otherwise looks good to go to me!

@sd109
Copy link
Contributor

sd109 commented Dec 18, 2025

We should update this admin guide template to refer to these new docs once they're available: https://github.com/azimuth-cloud/azimuth-config/blob/devel/environments/capi-mgmt-example/admin-guide.template.md

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.

4 participants