docs: add a Local state page for score-compose and score-k8s#292
docs: add a Local state page for score-compose and score-k8s#292Siddhartha-singh01 wants to merge 1 commit into
Conversation
Adds a dedicated page that consolidates what the .score-compose/ and .score-k8s/ directories contain, whether they are mandatory, when the local state helps (random secrets, non-hermetic outputs across multiple generate runs), and when the target platform should own state instead. Cross-links the four existing places that touch the topic so they point back to the central page. Signed-off-by: Siddhartha Singh <siddharthagithub0007@gmail.com>
|
Hi @mathieu-benoit first off, really sorry I went ahead without waiting for the formal assignment on this one. I got into the issue, started reading through the five places it's mentioned , and before I knew it I had a full draft ready. I opened it as #292. Could you take a look whenever you have a moment? If anything in there feels off the placement under Score Implementation CLIs, the section ordering, wording that misses a nuance, the postgres example not being quite the right one, or anything else please be completely candid. I'd much rather rework it now than have something half-right merged. Whatever you decide on the page, I'll respect it fully and make the changes happily. Thanks for the detailed outline in the issue it made the page much easier to put together than starting from a blank canvas. |
|
@Siddhartha-singh01, no worries at all, thanks for being proactive and taking initiatives like this! I'll review this later. |
Closes #266
Adds a dedicated Local state page under Score Implementation CLIs
that consolidates the answers to the questions in the issue: what the
.score-compose/and.score-k8s/directories are for, whether they aremandatory, when they help, and when the platform should own state instead.
What the page covers
state.yamland*.provisioners.yaml,with a tree showing the post-
initlayout.generatecommands fail without aninit.postgresresource, showing how the random password written to
state.yamlstays stable across successive
generateruns.managed Score implementations.
.gitignoreguidance.score-k8sexample instead of duplicating it.Cross-links added
The four existing places that touch the topic now link back to the new
page so they stop being the de-facto documentation:
score-composeCLIinitsectionscore-k8sCLIinitsectionscore-k8sstate in the CI/CD how-toinitsubcommand bullet in Create a Score implementationEach cross-link is a single sentence appended to the existing paragraph;
no surrounding text is restructured.
Test plan
yarn run hugobuilds cleanyarn run dprint checkpasses/docs/score-implementation/local-state/relrefcross-links resolvescore-composepostgresprovisioner and the existing CLI docs