Publikace v kostce

Nejkratší cesta od úpravy ke zveřejnění. Podrobnosti a první nastavení popisuje Jak tvořit a upravovat nápovědu, tady jsou jen hotové recepty.

Jak to funguje (na 30 vteřin)

Obsah putuje ve dvou krocích, nic se nezveřejní omylem:

 vaše úpravy ──sdocs send──▶ připravovaná ──sdocs release──▶ zveřejněná
                             dokumentace                     dokumentace

Dokumentace	Adresa	Kdo ji vidí
připravovaná	https://next.docs.solidapp.cz	kolegové
zveřejněná (živý web)	https://docs.solidpixels.com	veřejnost

Směr příkazů: pull stahuje k vám, send odesílá do připravované dokumentace, release ji zveřejňuje. Kdykoli se ztratíte, sdocs status poradí.

Recept: oprava textu nebo překlepu

sdocs pull        # stáhnout aktuální stav
# … upravte soubor v src/content/docs/ …
sdocs send        # odeslat do připravované dokumentace (kontrola + potvrzení)
sdocs release     # rovnou i zveřejnit

release ukáže úplný seznam toho, co se zveřejní, a chce napsat slovo release. Pokud v seznamu vidíte i cizí změny, které ještě nemají jít ven, zveřejnění zrušte a domluvte se s autorem.

Recept: větší úprava s náhledem

sdocs pull
sdocs up          # živý náhled na http://localhost:4321
# … pište, prohlížeč se obnovuje sám …
sdocs build       # kontrolní náhled s vyhledáváním na http://localhost:4322
sdocs send "Popis změny"
sdocs down        # úklid

Zveřejníte později příkazem sdocs release — klidně až po odsouhlasení kolegy, kteří změny mezitím vidí v připravované dokumentaci.

Recept: sdílený náhled rozpracované větve

Pracujete-li ve vlastní git větvi (např. dokumentace k připravované funkci), vytvoříte její sdílený náhled příkazem:

sdocs share

Příkaz vypíše dlouhou technickou adresu — zkopírujte ji z výpisu a pošlete kolegovi. Sdílený náhled po smazání větve sám zmizí.

Recept: úprava bez instalace čehokoli

1. Na stránce klikněte na Edit page — otevře se soubor v GitLabu.
2. Upravte text a uložte (commit) do větve develop.
3. Kontrola v CI změnu prověří a za pár minut je v připravované dokumentaci.
4. Zveřejnění pak proběhne příkazem sdocs release (nebo o něj požádejte kohokoli s lokálním prostředím).

Když kontrola najde chybu (rozbitý odkaz, chybějící title…), změna se do připravované dokumentace nedostane — přijde vám e-mail z GitLabu s odkazem na detail.

Když něco nefunguje

Situace	Řešení
nevím, v jakém jsem stavu	sdocs status
náhled nenaběhl / divné chyby	sdocs logs, případně sdocs clean a znovu
send hlásí konflikt	nejdřív sdocs pull, pak znovu send
chci vrátit zveřejněnou změnu	upravte obsah zpět a znovu send + release