Dokumentaatio

Mikä on dokumentoitu ja mikä ei vielä

Julkista dokumentaatioportaalia ei ole tänään. Dokumentaatio itsessään on olemassa — noin 200 sivua — mutta se sijaitsee yksityisessä arkistossa, toimitetaan asennuksen mukana eikä sillä ole vielä renderöityä versioitua julkista sivustoa. Sen sijaan että linkittäisimme portaaliin jota ei ole, tässä on jokaisen osan rehellinen tila.

Kohde	Tila	Mitä se tarkoittaa tänään
Käyttöönotto- ja käyttöohjeet	saatavilla	Kirjoitettu ja valmis. Toimitetaan asennuksen mukana; ei julkisella sivustolla.
Arkkitehtuuriviite	saatavilla	Kirjoitettu. Osa ajonaikaisista sisäosista on yhä dokumentoimatta.
Tuotteen rajoitukset ja tunnetut puutteet	saatavilla	Kirjoitettu suorasukaisesti. Paras yksittäinen lähde siihen mikä ei vielä toimi.
HTTP-API-viite	saatavilla	Viite luodaan hubin OpenAPI-dokumentista jokaisen julkaisun yhteydessä, ja siinä on hubin versio.
Ilmaraollisen asennuksen ja päivityksen ohjeet	valinnainen	Kirjoitettu, ja merkityksellisiä vain jos valitset ilmaraollisen käyttöönoton. Suunnattu tänään julkaisuinsinööreille, ei ylläpitäjillesi.
Asiakkaille suunnattu itse isännöinnin asennusopas	suunnitteilla	Kirjoittamatta. Asennustyökalut toimivat ja on testattu; opasta, jota Caldyrin ulkopuolinen insinööri voisi seurata, ei vielä ole.
Renderöity versioitu julkinen dokumentaatioportaali	suunnitteilla	Ei rakennettu. Ei generaattoria, ei build-vaihetta, ei verkkotunnusta. Tämä sivu on paikanpitäjä siihen asti.
Dokumentaatio venäjäksi, espanjaksi, viroksi ja suomeksi	työn alla	Käännetyt sivut ovat olemassa, mutta jäävät englannista jälkeen eikä niitä ole tarkistettu englannin yhtenäistämisen jälkeen.
Arkkitehtuuripäätösten kirjaukset	suunnitteilla	Niitä ei ole. Päätökset ovat pääteltävissä commit-historiasta, mikä ei ole sama asia.
Versioitu tietoturvadokumentti	suunnitteilla	Kirjoittamatta. Turvallisuussivu on yleiskatsaus, ei whitepaper, ja se on tarkoituksella merkitty niin — päivättyä versioitua ladattavaa dokumenttia ei ole.
Koneluettavasta skeemasta generoitu API-viite	saatavilla	Valmis. Hubi tarjoaa OpenAPI-dokumenttinsa osoitteessa /api/openapi.json hubin versiolla, ja viitesivu renderöidään siitä jokaisen julkaisun yhteydessä.
Kubernetes- ja Helm-käyttöönotto-opas	tutkimus	Selvitettävänä. Tänään ei ole charttia eikä manifesteja; tuettu muoto on Docker Compose isännässä.

Jos tarvitset jotain kirjoittamatonta kohtaa Caldyrin arviointiin, pyydä, niin lähetämme mitä on, sen sijaan että kertoisimme sen olevan julkaistu.