siderolabs / siderolabs/docs

Clarify persist option

Open
#512 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
11
Forks
76
Avg merge
3d 5h
Merged PRs (30d)
26

Description

Heya, just wondering if someone could clarify the v1alpha1.Config persist option in the documentation.
(Edit to add: The option doesn't seem to appear in this page, even though it is generated with talosctl gen config. Could this be changed?)

Its description near the middle of a different page seems to be the inverse of how the option functions:

persist: true # Indicates whether to pull the machine config upon every boot.

The use of "whether" here seems to imply to me that the value should be true if I wish to pull the machine config upon every boot. However, the name persist seems to imply the opposite.

I've also made a pull request to fix a simpler typo issue, but I felt this concern would be best left to someone with a better understanding of Talos than I. Thanks for your time 😊

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked v1alpha1.Config reference and the controllers-resources page, then compare both descriptions with the output of talosctl gen config. Confirm what persist does on boot and whether it should appear in the generated configuration reference. Done means the option is documented on the reference page and its true/false behavior is described unambiguously.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.