Dokumentatsioon

Mis on dokumenteeritud ja mis veel mitte

Avalikku dokumentatsiooniportaali täna ei ole. Dokumentatsioon ise on olemas — umbes 200 lehekülge — kuid see asub privaatses hoidlas, tarnitakse koos paigaldusega ja sellel pole veel renderdatud versioonitud avalikku saiti. Selle asemel, et viidata portaalile, mida pole, on siin iga osa aus seis.

Punkt	Olek	Mida see täna tähendab
Juurutus- ja käitusjuhendid	olemas	Kirjutatud ja täielikud. Tarnitakse paigaldusega; avalikul saidil neid ei ole.
Arhitektuuri viide	olemas	Kirjutatud. Osa käitusaja siseehitusest on veel dokumenteerimata.
Toote piirangud ja teadaolevad lüngad	olemas	Kirjutatud otsekoheselt. Parim üksikallikas selle kohta, mis veel ei tööta.
HTTP API viide	olemas	Viide genereeritakse iga väljalaskega hubi OpenAPI dokumendist ja kannab hubi versiooni.
Õhuvahega paigalduse ja uuenduse juhendid	valikuline	Kirjutatud ja asjakohased ainult siis, kui valid õhuvahega juurutuse. Täna on need mõeldud väljalaskeinseneridele, mitte sinu operaatoritele.
Kliendile mõeldud ise majutamise juhend	plaanis	Kirjutamata. Paigaldustööriistad töötavad ja on testitud; juhendit, mida Caldyri-väline insener saaks järgida, veel ei ole.
Renderdatud versioonitud avalik dokumentatsiooniportaal	plaanis	Ehitamata. Generaatorit, ehitussammu ega domeeni ei ole. See leht on kohatäide, kuni portaal tekib.
Dokumentatsioon vene, hispaania, eesti ja soome keeles	töös	Tõlgitud lehed on olemas, kuid jäävad inglise keelest maha ega ole pärast ingliskeelse konsolideerimist üle vaadatud.
Arhitektuuriotsuste kirjed	plaanis	Neid ei ole. Otsused on taastatavad commit'ide ajaloost, mis ei ole sama asi.
Versioonitud turvalisuse ülevaade	plaanis	Kirjutamata. Turvaleht on ülevaade, mitte whitepaper, ja on meelega nii märgistatud — kuupäevastatud versioonitud dokumenti allalaadimiseks ei ole.
Masinloetavast skeemist genereeritud API viide	olemas	Valmis. Hub serveerib oma OpenAPI dokumenti aadressil /api/openapi.json koos hubi versiooniga ning viitelehekülg renderdatakse sellest iga väljalaskega.
Kubernetese ja Helmi juurutusjuhend	uuring	Uurime. Täna ei ole ei chart'i ega manifeste; toetatud kuju on Docker Compose hostil.

Kui vajad Caldyri hindamiseks mõnda kirjutamata punkti, küsi ja me saadame selle, mis olemas on, selle asemel et öelda, nagu oleks see avaldatud.