Skip to content

docs: rename Developers nav to Contributors and add scope warning#382

Merged
runleveldev merged 1 commit into
mainfrom
docs/contributors-section-warning
Jun 24, 2026
Merged

docs: rename Developers nav to Contributors and add scope warning#382
runleveldev merged 1 commit into
mainfrom
docs/contributors-section-warning

Conversation

@horner

@horner horner commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

  • Renamed the Developers nav menu to Contributors in zensical.toml.
  • Added a warning admonition to every page in the section clarifying it documents how the Manager, Nodes, and cluster work internally and how to contribute to the opensource cluster.
  • The warning directs developers who just want to run their own code on the cluster to the Users documentation instead.

DRY

The warning text is defined once as a contributor_warning macro in main.py (matching the existing proxmox_url/manager_url pattern) and referenced via {{ contributor_warning }} on each page, so edits happen in one place.

Housekeeping

  • Added playwright-report/ and test-results/ to create-a-container/.gitignore.

Rename the Developers menu to Contributors and add a shared warning admonition to every contributor page clarifying the section covers how the Manager, Nodes, and cluster work internally, directing developers who just want to run code to the Users docs. Warning text is defined once as a contributor_warning macro for DRY reuse. Also gitignore Playwright test artifacts.
@runleveldev runleveldev merged commit c0ea948 into main Jun 24, 2026
8 checks passed
@runleveldev runleveldev deleted the docs/contributors-section-warning branch June 24, 2026 12:52
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.

2 participants