Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Oct 10, 2025

Copy link

coderabbitai bot commented Oct 10, 2025

Walkthrough

Replace many reStructuredText installation and cloud docs with new Markdown equivalents: add Markdown guides (OS installs, container/Kubernetes, AWS/Azure, config fragments, Docker/Kubernetes examples) and remove corresponding .rst sources. All edits are documentation-only.

Changes

Cohort / File(s) Summary
Install hub & config
docs/install/index.md, docs/install/index.rst, docs/install/configure.md, docs/install/configure.rst
Add a Markdown install hub and configuration page; remove the original reST index and configure pages.
Control & post‑install fragments
docs/install/_control-linux.md, docs/install/_control-linux.rst, docs/install/_post-install.md, docs/install/_post-install.rst
Add Markdown include fragments for Linux service control and post-install notes; remove corresponding .rst fragments.
OS installers (Debian/RedHat/Tarball/Windows)
docs/install/debian-ubuntu.md, docs/install/debian-ubuntu.rst, docs/install/redhat.md, docs/install/redhat.rst, docs/install/tarball.md, docs/install/tarball.rst, docs/install/windows.md, docs/install/windows.rst
Introduce Markdown installers for Debian/Ubuntu, Red Hat/SUSE, tarball, and Windows; delete prior .rst versions.
Container index & Docker
docs/install/container/index.md, docs/install/container/index.rst, docs/install/container/docker.md, docs/install/container/docker.rst
Add Markdown container index and Docker guide (quickstart, compose, best practices, troubleshooting); remove .rst counterparts.
Kubernetes (index, classic, operator)
docs/install/container/kubernetes/index.md, docs/install/container/kubernetes/index.rst, docs/install/container/kubernetes/kubernetes.md, docs/install/container/kubernetes/kubernetes.rst, docs/install/container/kubernetes/kubernetes-operator.md, docs/install/container/kubernetes/kubernetes-operator.rst
Add Markdown Kubernetes docs (StatefulSet examples, Operator guide, CR examples); remove the .rst files.
Cloud index & AWS
docs/install/cloud/index.md, docs/install/cloud/index.rst, docs/install/cloud/aws/index.md, docs/install/cloud/aws/index.rst, docs/install/cloud/aws/ec2-setup.md, docs/install/cloud/aws/ec2-setup.rst, docs/install/cloud/aws/s3-setup.md, docs/install/cloud/aws/s3-setup.rst, docs/install/cloud/aws/aws-terraform-setup.md, docs/install/cloud/aws/aws-terraform-setup.rst
Add Markdown cloud index and AWS guides (EC2 discovery, S3 snapshot repo, Terraform examples); remove the .rst versions.
Cloud Azure
docs/install/cloud/azure/index.md, docs/install/cloud/azure/index.rst, docs/install/cloud/azure/vm.md, docs/install/cloud/azure/vm.rst, docs/install/cloud/azure/terraform.md, docs/install/cloud/azure/terraform.rst
Add Markdown Azure VM and Terraform guides; delete the original .rst files.
Cloud hosting index
docs/install/cloud/index.md, docs/install/cloud/index.rst
Add a Markdown cloud hosting index and remove the reST index.
Container cloud index update
docs/install/container/index.md
New Markdown index for container-based installation (migrated from .rst).
Tarball & Windows guides
docs/install/tarball.md, docs/install/windows.md
New Markdown tarball and Windows installation guides; corresponding .rst files removed.
Feature ref update
docs/feature/cloud/index.md
Minor rubric reference removal.

Sequence Diagram(s)

Changes are documentation-only and do not modify runtime control flow; no sequence diagram is provided.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related issues

Possibly related PRs

Suggested labels

sanding-1200

Suggested reviewers

  • kneth
  • surister
  • bmunkholm

Poem

I hop through docs with nimble paws,
Swapping .rst for markdown laws.
Clouds and clusters, guides anew,
Pages bloom where old ones flew.
A carrot snack — docs fresh for you! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly and accurately summarizes the core change of this PR by indicating that all install documentation files are being converted from their existing format to MyST (Markdown), making it clear and directly related to the changeset without extraneous detail.
Description Check ✅ Passed The description directly relates to the changes by stating the continuation of converting documents from reStructuredText to Markdown and provides a relevant preview link and issue references that map to the documented file conversions.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch markdown-more

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotl amotl requested review from kneth and surister October 10, 2025 17:16
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl added the refactoring Changing shape or layout, or moving content around. label Oct 10, 2025
coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

Copy link
Member

@kneth kneth left a comment

Choose a reason for hiding this comment

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

Let me be honest: I didn't review it all, and I might not have seen the footnote.

@amotl amotl merged commit 2c19567 into main Oct 15, 2025
3 checks passed
@amotl amotl deleted the markdown-more branch October 15, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance C'est la vie. refactoring Changing shape or layout, or moving content around.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants