Skip to content

Docs/admin docs#27

Open
andrewfulton9 wants to merge 41 commits into
nebari-dev:mainfrom
andrewfulton9:docs/admin_docs
Open

Docs/admin docs#27
andrewfulton9 wants to merge 41 commits into
nebari-dev:mainfrom
andrewfulton9:docs/admin_docs

Conversation

@andrewfulton9

@andrewfulton9 andrewfulton9 commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Reference Issues or PRs

#10

Builds off of #11

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

I verified kubectl commands and configuration with a deployed cluster on hetzner.

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • [ x If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

I used different sidebar sections in this then what was previously used in the nebari docs to make it more clear who different pages are for. I can change this back to “get started” “how-to guides” sections that we were using for packs but I will defer to others. It may be worth discussing this before continuing on on the other packs.

Add # -- and @default -- comments to all keys so helm-docs can
generate a complete values reference table. Also add .helmignore
to exclude docs/node_modules from helm's file scanner (was causing
a spurious 5 MiB file-size lint error).
Comment thread values.yaml
# -- Cluster hostname for the NebariApp route (e.g. `nebi.your-cluster.example.com`).
# **Required** when `nebariapp.enabled` is `true`.
# @default -- `""` (must be set explicitly)
hostname: ""

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.

I uncommented this so that it would show up in the generated values.md file. Is that OK?

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.

1 participant