coreos / coreos/fedora-coreos-docs

Add "Best Practice" page ?

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

Nobody has claimed this yet.

Dominant language
Shell
Stars
68
Forks
156
Avg merge
14d 2h
Merged PRs (30d)
1

Description

It seems to me that the docs are missing a "best practice" page as there are currently lots of hints in the manual (either explicit or implicit) that really should be consolidated onto a "best practice" page.

For example:

  • The implied best practice on the Updates Streams page that you should consider haivng testing and next canaries
  • The implied best practice in relation to Zincati wariness that some nodes should have a more aggressive value for canary purposes
  • Given CoreOS is a rolling distro, details on how to manage configs between releases (e.g. avoid issues with breaking changes in configs)
  • Probably many tips and tricks for managing Butane files, perhaps especially around merge and replace.

I'm sure there's a bunch of things that battle scarred sysadmins have picked up over the years ? i.e. "I wish somebody told me that when I started using CoreOS".

The CoreOS devs also probably know which cupboards the skeletons are hidden in and could hint at things to avoid because they are flaky / not stable. 😉

I'm new to CoreOS but this sort of thing would be very useful when strarting from a greenfield deployment. People should not have to learn the hard way.

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 by reviewing the existing manual pages on Update Streams, Zincati canary configuration, release-to-release configuration changes, and Butane merge and replace behavior. Identify guidance that can be consolidated and confirm it with the CoreOS maintainers. Done means a new best-practices page covers agreed recommendations and clearly separates stable advice from known caveats.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.