Skip to content

docs: restructure deployment guide#310

Open
ma-hartma wants to merge 23 commits into
mainfrom
deployment-guide-restructure
Open

docs: restructure deployment guide#310
ma-hartma wants to merge 23 commits into
mainfrom
deployment-guide-restructure

Conversation

@ma-hartma

@ma-hartma ma-hartma commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Description

We had a discussion in the team about restructuring the deployment guide.
Parts of the concept area do not belong there, but should go under the deployment guide.
For the guide not to get too bloated, this PR splits the guide into sub pages and moves parts from the concepts area to the regarding sub pages.

The concepts should come before the deployment guide, so there is a separate issue:
#312

Used AI-Tools ✨

  • Qwen3.6-35B (local)

References:

@metal-robot metal-robot Bot added the area: documentation Affects the documentation area. label Jun 30, 2026
@netlify

netlify Bot commented Jun 30, 2026

Copy link
Copy Markdown

Deploy Preview for metal-stack-io ready!

Name Link
🔨 Latest commit f629c66
🔍 Latest deploy log https://app.netlify.com/projects/metal-stack-io/deploys/6a467a56477c8d0008999260
😎 Deploy Preview https://deploy-preview-310--metal-stack-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
@ma-hartma ma-hartma marked this pull request as ready for review July 1, 2026 01:47
@ma-hartma ma-hartma requested a review from a team as a code owner July 1, 2026 01:47
@ma-hartma ma-hartma requested a review from l0wl3vel July 1, 2026 01:49
Comment thread docs/04-For Operators/03-Deployment/02_initial-cluster.md
Comment thread docs/04-For Operators/03-Deployment/01_guide.md Outdated
Comment thread docs/04-For Operators/03-Deployment/02_initial-cluster.md Outdated
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx
Comment thread docs/04-For Operators/03-Deployment/05_gardener.md Outdated
@ma-hartma

Copy link
Copy Markdown
Contributor Author

Thanks for all the review @simcod and @majst01!

@ma-hartma ma-hartma force-pushed the deployment-guide-restructure branch from c534aa8 to bdb6362 Compare July 1, 2026 12:01
@ma-hartma ma-hartma force-pushed the deployment-guide-restructure branch from 82b6b06 to a2164b5 Compare July 1, 2026 21:11
Comment thread docs/04-For Operators/03-Deployment/03_control-plane.mdx Outdated
@ma-hartma

Copy link
Copy Markdown
Contributor Author

Still working on the guide, now streamlining and connecting this to an overhauled concepts section PR.
I'll request another review once I'm finished. Thanks for the review for now!

Comment on lines +21 to +23
:::info
If you do not want to use Ansible for deployment, you need to come up with a deployment mechanism by yourself. However, you will probably be able to re-use some of our contents from our [metal-roles](https://github.com/metal-stack/metal-roles) repository, e.g. the Helm chart for deploying the metal control plane.
:::

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.

Am I missing something here? What can be re-used from the metal-roles repo when not using ansible?

For example the metal-control-plane helm chart is in https://github.com/metal-stack/helm-charts/ not metal-roles.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Made it more explicit, please re-check!

Comment thread docs/04-For Operators/03-Deployment/02_initial-cluster.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: documentation Affects the documentation area.

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

4 participants