docs | ||
LICENSE | ||
mkdocs.yml | ||
README.md |
Oscloud-docs
Tento repozitář obsahuje dokumentaci a návody pro platformu OSCloud, využívající MkDocs pro snadnou správu a nasazení.
Přehled projektu
- Účel: Poskytnout podrobné návody a dokumentaci k používání a správě služeb OSCloud.
- Technologie: MkDocs – statický generátor stránek, který převádí soubory ve formátu Markdown na funkční a esteticky přehlednou webovou dokumentaci.
Jak začít
- Klonování repozitáře:
git clone https://gitea.oscloud.cz/tvůj-uživatel/oscloud-docs.git
- Vytvoření a aktivace virtuálního prostředí: Nejprve vytvoř virtuální prostředí a aktivuj ho
python -m venv venv
source venv/bin/activate
- Instalace MkDocs:
pip install mkdocs
- Spuštění lokálně: Použij tento příkaz k spuštění MkDocs serveru a prohlížení dokumentace lokálně:
mkdocs serve
- Vytvoření statických souborů: K vygenerování statických souborů pro nasazení:
mkdocs build
- Aktivuj virtuální prostředí Pokud chceš spustit lokální server MkDocs, nejprve aktivuj virtuální prostředí (pokud jsi ho již vytvořil):
source /home/archos/mkdocs/venv/bin/activate
- Deaktivace virtuálního prostředí: Po skončení práce vypni virtuální prostředí příkazem:
deactivate
Nasazení na OSCloud pomocí LAMP
-
Přístup k LAMP serveru na OSCloud: Přihlas se do LAMP aplikace přes administraci na adrese
my.oscloud.cz
a otevři terminál pro danou aplikaci. -
Instalace MkDocs na serveru: V terminálu na serveru spusť tento příkaz:
pip install mkdocs
- Vytvoření nového MkDocs projektu: Na serveru vytvoř nový projekt MkDocs pomocí tohoto příkazu:
mkdocs new mysite
-
Nahrání souborů: Nahrávej soubory projektu do kořenového adresáře LAMP aplikace pomocí FTP nebo SCP.
-
Spuštění MkDocs serveru: Na serveru spusť MkDocs příkazem:
mkdocs serve
Dokumentace bude dostupná na veřejné URL, kterou LAMP aplikace poskytuje.
Nasazení na OSCloud pomocí Surfer
- Lokální příprava souborů: Vygeneruj statické soubory pro MkDocs příkazem:
mkdocs build
Tím se vytvoří složka site
, která obsahuje všechny statické soubory tvé dokumentace.
-
Nahrání na Surfer: Přihlas se do administrace OSCloud a otevři aplikaci Surfer.
-
Nahrání souborů přes rozhraní Surferu: Nahraj obsah složky site (statické soubory vygenerované příkazem mkdocs build) přímo do Surferu pomocí rozhraní nebo přes FTP/SCP.
Dokumentace online: Jakmile jsou soubory nahrané, dokumentace bude okamžitě dostupná na veřejné URL adrese Surfer aplikace.
Přispívání
Neváhejte nahlásit problémy nebo přispívat úpravami a vylepšeními do dokumentace prostřednictvím pull requestů.