🇨🇿 Czech translation (#269)
Let's translate beloved Disroot to my fellow citizens. Czech 🇨🇿 translation And where will be best to start? Let's translate Howto Initial commits... Reviewed-on: #269 Reviewed-by: Fede.- <fede@no-reply@disroot.org> Co-authored-by: zenobit <zenobit@no-reply@disroot.org> Co-committed-by: zenobit <zenobit@no-reply@disroot.org>
This commit is contained in:
parent
8179dc9fd4
commit
af5d87736a
15 changed files with 883 additions and 0 deletions
103
README_CS.md
Normal file
103
README_CS.md
Normal file
|
@ -0,0 +1,103 @@
|
|||
<p align="center">
|
||||
|
||||
![](h2.png)
|
||||
|
||||
</p>
|
||||
|
||||
<h1 align="center">Disroot's Jak na to a překlady</h1>
|
||||
|
||||
<h2 align="center">· Zapojte se a přispějte ·</h2>
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
Tento repozitář obsahuje soubory projektu **Disroot's Howto** a informace k vytváření, úpravám a překladům těchto souborů.
|
||||
|
||||
Cílem **Disroot's Howto Project** je především vytváření, údržba a zpřístupňování uživatelských příruček, návodů a konfigurací různých služeb a softwaru, které platforma **Disroot** poskytuje. Také poskytnout nástroje, návody a postupy pro každého, kdo chce přispět vytvořením, úpravou a překladem těchto návodů.
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
# 1. Předpoklady
|
||||
- a. Požadovaný software
|
||||
- b. Účet Gitea
|
||||
- c. Požádejte o přístup k našemu úložišti
|
||||
- d. Nastavte své uživatelské jméno a e-mail.
|
||||
|
||||
Pro získání kopie projektu na svém lokálním počítači a zahájení práce je třeba postupovat podle následujících pokynů.
|
||||
|
||||
## a. Požadovaný software:
|
||||
Nejprve musíte mít nainstalovaný následující software.
|
||||
- ## git<br>
|
||||
Systém pro kontrolu verzí pro sledování změn v howto a překladech tak jak jsou psány.<br>
|
||||
· [**Co je git?**](https://cs.wikipedia.org/wiki/Git) <br> · [**Stažení a návod k instalaci**](https://git-scm.com/downloads) (anglicky)
|
||||
|
||||
- ## text editor with markdown format files support<br>
|
||||
_Doporučené programy:_<br>
|
||||
· **VSCodium**, Komunitou řízená, volně licencovaná binární distribuce editoru VS Code společnosti Microsoft. [[**Stažení a návod k instalaci**](https://vscodium.com/)]<br> (anglicky)
|
||||
· **Neovim**, hyperextenzivní textový editor založený na Vimu. [[**Stažení a návod k instalaci**](https://github.com/neovim/neovim/wiki/Installing-Neovim)]<br> (anglicky)
|
||||
· **Kate Editor**, funkcemi nabitý textový editor. [[**Stažení a návod k instalaci**](https://kate-editor.org/cs/get-it/)]
|
||||
|
||||
<br>
|
||||
|
||||
## b. A účet Gitea
|
||||
To abyste mohli odesílat změny, které provedete v howtos, ať už je překládáte, upravujete, nebo píšete, potřebujete mít účet v instanci **Gitea**.
|
||||
|
||||
Pro registraci účtu v instanci, kde je náš repozitář, přejděte [**sem**](https://git.disroot.org/user/sign_up).
|
||||
|
||||
<br>
|
||||
|
||||
## c. Požádejte o přístup do našeho úložiště
|
||||
Chcete-li mít možnost odevzdávat změny do úložiště git **Disroot**, musíte požádat o přístup. To provedete prostřednictvím naší stránky projektu git.
|
||||
|
||||
<br>
|
||||
|
||||
## d. Nastavte své uživatelské jméno a e-mailovou adresu
|
||||
To je nezbytné, abyste mohli odesílat svou práci ze svého počítače do vzdáleného úložiště. Nastavte uživatelské jméno a e-mail pro git
|
||||
|
||||
- otevřete terminál a spusťte git<br>
|
||||
`git init`<br>
|
||||
|
||||
- Doplňte vlatní údaje do následujících příkazů a vložte do terminálu:<br>
|
||||
`git config --global user.email "uživatel@email"`<br>
|
||||
`git config --global user.name "Uživatelskéjméno"`
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
# 2. Vytvoření / překlad návodu k použití
|
||||
Proces vytváření nebo překládání howto není složitý a vyžaduje jen trochu cviku, abyste se ho naučili.
|
||||
|
||||
Postup je poměrně jednoduchý:
|
||||
|
||||
1. Získejte kopii souborů, na kterých budete pracovat;
|
||||
2. pracujete na souborech lokálně ve svém počítači,
|
||||
3. po dokončení je odešlete.
|
||||
|
||||
|
||||
První věcí, kterou je třeba udělat, je klonování úložiště, to znamená vytvoření místní kopie vzdálených souborů. Všechna práce bude probíhat na této kopii.
|
||||
|
||||
<br>
|
||||
|
||||
## a. Klonování úložiště
|
||||
Repozitář git je složka projektu obsahující soubory, které byly nebo mají být přeloženy, a podrobnou historii sledování těchto změn.
|
||||
|
||||
Pro klonování repozitáře otevřete terminál v adresáři, do kterého chcete repozitář naklonovat. Poté použijete příkaz `git clone`, což je instrukce pro klonování úložiště zadáním jeho adresy. V našem případě to bude:
|
||||
|
||||
`git clone https://git.disroot.org/Disroot/howto`
|
||||
|
||||
Jakmile bude úložiště zkopírováno na váš pevný disk, zobrazí se adresář `howto` obsahující všechny soubory projektu. Později jej můžete přesunout na libovolné místo ve svém počítači.
|
||||
|
||||
<br>
|
||||
|
||||
## b. Vytvoření / překlad návodu
|
||||
Jakmile jste zkopírovali úložiště na svůj počítač, můžete začít vytvářet, upravovat a/nebo překládat podle kroků popsaných v těchto návodech:
|
||||
|
||||
- [Jak přispívat k návodům **Disroot**](https://howto.disroot.org/cs/contribute)<br>
|
||||
|
||||
- [Jak postupovat při tvorbě návodů a překladů](https://howto.disroot.org/cs/contribute/procedure)
|
||||
|
||||
<br>
|
||||
|
||||
# 3. Licence
|
||||
Dokumentace **Disroot's Howto** je licencována pod [Creative Commons Attribution-ShareAlike 4.0 mezinárodní licence](https://creativecommons.org/licenses/by-sa/4.0/deed.cs)
|
23
pages/01.home/home.cs.md
Normal file
23
pages/01.home/home.cs.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Domov
|
||||
content:
|
||||
items:
|
||||
'@taxonomy':
|
||||
category: [topic]
|
||||
order:
|
||||
by: default
|
||||
dir: asc
|
||||
pagination: true
|
||||
---
|
||||
|
||||
### Vítejte na stránkách Disroot's How-to.
|
||||
|
||||
Hlavním cílem těchto stránek je pomoci vám zorientovat se v různých službách **Disroot**.
|
||||
|
||||
Naším cílem je pokrýt všechny služby se všemi funkcemi, které **Disroot** poskytuje, pro všechny platformy a/nebo operační systémy a také co největší počet klientů pro nejpoužívanější zařízení.
|
||||
|
||||
Jedná se o velmi ambiciózní a časově náročný projekt, který vyžaduje mnoho práce. Protože si však myslíme, že by mohl být přínosný nejen pro naše uživatele (disrootery), ale i pro všechny komunity **Svobodného softwaru** a **Open Source** používající stejný nebo podobný software, myslíme si, že stojí za to. Z tohoto důvodu je jakákoli pomoc vždy potřebná a vítaná.
|
||||
|
||||
Pokud si tedy myslíte, že nějaký návod chybí, informace nejsou přesné nebo by se daly vylepšit, kontaktujte nás a (ještě lépe) začněte psát návod sami.
|
||||
|
||||
Chcete-li znát různé způsoby, jak můžete přispět, podívejte se do této [**sekce**](/cs/contribute).
|
24
pages/02.tutorials/01.User/01.Account/docs.cs.md
Normal file
24
pages/02.tutorials/01.User/01.Account/docs.cs.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: 'Účet'
|
||||
updated:
|
||||
published: true
|
||||
visible: true
|
||||
indexed:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- user
|
||||
- account
|
||||
- administration
|
||||
page-toc:
|
||||
active: false
|
||||
---
|
||||
|
||||
# Správa účtu
|
||||
|
||||
## [Administrace](administration)
|
||||
Změna nebo reset hesla, úprava oznámení o reset e-mailů, bezpečnostní otázky, přístupové formuláře, odstranění účtu.
|
||||
|
||||
## [Požádat o Alias](alias-request)
|
||||
Jak požádat o e-mailové aliasy, formuláře.
|
17
pages/02.tutorials/01.User/docsparent.cs.md
Normal file
17
pages/02.tutorials/01.User/docsparent.cs.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Uživatel
|
||||
subtitle: Správa účtu a osobních dat
|
||||
icon: fa-user
|
||||
published: true
|
||||
visible: true
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
- topic
|
||||
page-toc:
|
||||
active: false
|
||||
---
|
||||
|
||||
# Uživatel
|
||||
V této části najdete užitečné informace o správě svého účtu.
|
||||
<br>
|
10
pages/02.tutorials/index.cs.md
Normal file
10
pages/02.tutorials/index.cs.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: "How-to: Služby"
|
||||
content:
|
||||
items:
|
||||
- '@taxonomy': {category: [topic]}
|
||||
order:
|
||||
by: folder
|
||||
dir: asc
|
||||
pagination: true
|
||||
---
|
43
pages/04.Contribute/01.procedure/docs.cs.md
Normal file
43
pages/04.Contribute/01.procedure/docs.cs.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: Postupy
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- procedure
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Howto Postupy: Co to znamená?
|
||||
Možnost napsat návod a zpřístupnit ho všem v jejich vlastních jazycích je zásadní pro podporu a propagaci nejen používání svobodného/libre a open source softwaru, ale také kolektivních myšlenek a akcí. Koordinace množství informací, které je třeba napsat a přeložit, je tedy důležitým úkolem, proto jsme vypracovali základní soubor kroků, které nám pomohou tohoto cíle dosáhnout.
|
||||
|
||||
Postup je poměrně jednoduchý:
|
||||
1. Získáme kopii souborů, na kterých budeme pracovat;
|
||||
2. na souborech pracujeme lokálně,
|
||||
3. a jakmile je dokončíme, odešleme je.
|
||||
|
||||
Zní to docela jednoduše, že? No, opravdu je. Každý krok procesu má samozřejmě svou vlastní sadu činností, které uvidíme později, ale to je v podstatě vše.
|
||||
|
||||
# Jaké nástroje potřebujeme?
|
||||
Pro naši práci používáme tři nástroje: **Git**, **textový editor** a **Gitea**.
|
||||
|
||||
Zvolili jsme **Git** z několika důvodů, z nichž hlavním je struktura našich dokumentů a jazyk kódu. Přestože existuje mnoho (a velmi dobrých) překladatelských nástrojů, které vypadají "uživatelsky přívětivěji", žádný z nich neodpovídá našemu případu použití ani nemá hotovou podporu textového formátu **Markdown**. V nejlepším případě to od nás bude vyžadovat masivní úpravy souborů, abychom je rozebrali na několik "textových úseků" nebo "řetězců". Dalším důležitým důvodem je, že **Git** nám umožňuje sledovat změny provedené v těchto souborech, což usnadňuje jejich správu a spolupráci na nich. A ještě jeden důvod je, že **Gitea** (software pro hostování kódu, který používáme spolu s **Gitem**) má mnoho užitečných funkcí pro organizaci a zlepšení práce na jednom místě.
|
||||
|
||||
Dobrá, pojďme se podívat na naše nástroje:
|
||||
|
||||
1. **Git**: Jste-li uživateli **GNU/Linux**, je velmi pravděpodobné, že jej již máte nainstalovaný (můžete si to ověřit ve správci softwarových balíčků nebo prostřednictvím terminálu příkazem `which git`). Pokud používáte **Microsoft Windows** nebo **Mac OS**, můžete si jej stáhnout z [zde](https://git-scm.com/downloads).
|
||||
|
||||
2. **Textový editor**: Ačkoli jich existuje celá řada, doporučujeme vám použít takový, který podporuje formát **Markdown** a má integraci se systémem **Git**. Tato kritéria nativně splňují **Kate Editor**, **Atom Text Editor** a **VSCodium**, které jsou navíc multiplatformním softwarem Free/Libre a Open Source. Z **praktických důvodů se však podíváme pouze na práci v Atomu** (v budoucnu zahrneme i další nástroje).
|
||||
|
||||
**Textový editor Atom**: [Stáhnout](https://atom.io/) - [Zdrojový kód](https://github.com/atom/atom)
|
||||
|
||||
3. **Účet Disroot Gitea**: Abyste mohli odeslat svou práci, musíte si zaregistrovat účet na naší instanci **Gitea** (přihlašovací údaje **Disroot** nebudou fungovat) a požádat o přístup do našeho úložiště.
|
||||
|
||||
[**Registrace nového účtu**](https://git.disroot.org/user/sign_up) na instanci **Disroot Gitea**.
|
||||
|
||||
Jakmile máte tyto nástroje, je čas je nastavit.
|
49
pages/04.Contribute/02.git/02.Troubleshooting/docs.cs.md
Normal file
49
pages/04.Contribute/02.git/02.Troubleshooting/docs.cs.md
Normal file
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: Odstraňování problémů
|
||||
subtitle:
|
||||
published: true
|
||||
visible: true
|
||||
indexed: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- git
|
||||
- troubleshooting
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Odstraňování problémů
|
||||
<a name="behind"></a>
|
||||
## Obsah
|
||||
- [Naše místní větev je "za" vzdálenou hlavní větví](#behind)
|
||||
|
||||
---
|
||||
|
||||
<a name="behind"></a>
|
||||
## Naše místní větev je "za" vzdálenou hlavní větví
|
||||
Zatímco pracujeme na naší větvi, ostatní uživatelé případně odevzdávají a slučují své vlastní změny, zejména pokud pracujeme na existujících souborech. Pokud již byly tyto změny od ostatních uživatelů sloučeny do **hlavní větve**, verze souborů, které jsme změnili, již nemusí být aktuální, a proto změny od ostatních uživatelů nemusí být zahrnuty do našich souborů. V takovém případě, pokud chceme nechat naše změny sloučit do **hlavní větve**, by se proces mohl docela zkomplikovat.
|
||||
|
||||
Proto musíme změny provedené ve vzdálené hlavní větvi začlenit do naší místní hlavní větve **dříve**, než můžeme **požádat** o **vytažení** (požadavek na sloučení). Tím ušetříme správcům i sobě spoustu zbytečné práce.
|
||||
|
||||
V systému Git existují dva způsoby, které nám umožňují integrovat/spojit/aktualizovat větve: **git merge** a **git rebase**.
|
||||
|
||||
**Git merge** porovná poslední dvě revize každé větve a "společného předka" obou větví, které chceme sloučit, a vytvoří novou revizi se změnami. Když sloučíme jednu větev do své vlastní, sloučíme historii obou větví dohromady. Pokud to pak uděláme znovu, začneme vytvářet řadu proložených historií.
|
||||
|
||||
**Git rebase** sleduje jednu po druhé revize provedené v jedné větvi a "replikuje" je do druhé. To znamená, že všechny naše místní revize se objeví na konci, za vzdálenými revizemi, a my budeme mít přehlednější historii. Proto je tato metoda upřednostňována.
|
||||
|
||||
Je důležité si uvědomit, že **rebase** je užitečná **pouze** tehdy, pokud ji aplikujeme na místní revize, které ještě nebyly "nahrány" do žádného vzdáleného repozitáře. Pokud provedeme "rebase" na lokální větvi, jejíž revize již byly odeslány do vzdálené větve, určitě dojde k řadě konfliktů.
|
||||
|
||||
Pokud tedy pracujeme na místní větvi a chceme do ní začlenit změny provedené ve vzdálené hlavní větvi, budeme muset provést "rebase".
|
||||
|
||||
Kroky pro rebase:
|
||||
1. Ujistěte se, že všechny změny jsou odevzdány pouze v naší místní větvi.
|
||||
2. V terminálu:
|
||||
- přepněte na **hlavní větev**: `git checkout master`;
|
||||
- aktualizujte **Hlavní větev**: `git pull`;
|
||||
- přepněte zpět do naší pracovní větve: `git checkout our.branch`;
|
||||
- aktualizujte naši pracovní větev z aktualizované **hlavní větve**: `git rebase master`.
|
||||
3. Nakonec ověřte změny a odevzdejte je do vzdáleného úložiště.
|
86
pages/04.Contribute/02.git/docs.cs.md
Normal file
86
pages/04.Contribute/02.git/docs.cs.md
Normal file
|
@ -0,0 +1,86 @@
|
|||
---
|
||||
title: "Git"
|
||||
published: true
|
||||
visible: true
|
||||
indexed: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- git
|
||||
- settings
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Git?
|
||||
Ano, **Git**. Je to řídicí systém verzí, software, který nám umožňuje sledovat úpravy souborů a uchovávat záznamy o všech provedených změnách, takže pokud se potřebujeme vrátit k určité verzi, můžeme to udělat relativně snadným způsobem. Je to také výkonný nástroj pro spolupráci, protože umožňuje mnoha lidem pracovat na stejných souborech projektu.
|
||||
|
||||
Naučit se základy systému Git a pracovat s ním může být nejen velmi užitečné, ale také zábavné.
|
||||
|
||||
|
||||
# Rozsah tohoto výukového kurzu
|
||||
Naše používání systému Git nevyžaduje vysokou úroveň technických znalostí, sadu potřebných základních příkazů se může naučit každý. A aby to bylo ještě jednodušší, existuje několik textových editorů s integrovaným systémem Git, které omezují interakci s terminálem na minimum.<br>
|
||||
Takže cílem následujících návodů je seznámit vás se základy systému Git, hlavního nástroje, který používáme pro správu souborů projektu **Howto**. Nebudeme se tedy zabývat všemi aspekty jeho používání, pouze některými základními pojmy a příkazy.
|
||||
|
||||
Pokud se o systém Git budete zajímat více, existuje spousta podrobných výukových programů a dokumentace o něm napsaných, které snadno najdete na internetu.
|
||||
|
||||
|
||||
# Co Git dělá?: Základní pojmy
|
||||
|
||||
![](en/git.png)
|
||||
|
||||
Když čtete výukový program **Disroot**, vidíte ve svém prohlížeči reprezentaci části kódu, v našem případě textového souboru zapsaného ve formátovací syntaxi zvané **Markdown**. Celý kód tohoto webu a jeho obsah je umístěn v úložišti **Git**, složce obsahující všechny soubory projektu a historii změn každého z těchto souborů (co se změnilo, kdo to změnil a proč se to změnilo).
|
||||
|
||||
V tomto úložišti (neboli repo) existuje **hlavní větev** (neboli "hlavní větev"), která je výchozí vývojovou linií projektu a ze které lze vytvářet různé další větve, aniž by došlo k jejímu narušení.
|
||||
|
||||
Představte si strom: "hlavní větev" by byla kmenem, ze kterého "vyrůstají a vyvíjejí se" různé větve. Jakmile dokončí svůj cyklus, mohou být začleněny do "kmene", nebo z něj dokonce "vypadnout", aniž by jej ovlivnily.
|
||||
|
||||
Hlavní větev je tedy ta, která obsahuje kód, který vidíme online (nebo "v produkci"), a větve, které vytváříme, jsou ty, které obsahují naši práci.
|
||||
|
||||
![](en/git_branches.png)
|
||||
|
||||
Tímto způsobem, když je třeba výukový program upravit (např. protože byl aktualizován nějaký software, v dokumentu byly nalezeny překlepy, je třeba přidat/odstranit nějaké informace atd) nebo přeložit, uděláme to, že zkopírujeme vzdálený repozitář do našeho počítače, abychom mohli na souborech pracovat lokálně. Tento postup se nazývá **klonování** a po jeho provedení jsou všechny úpravy a operace Git spravovány z našeho místního úložiště.
|
||||
|
||||
## Klonování úložiště **Howto Disroot**
|
||||
Jak jsme již zmínili, proces získání kopie všech souborů v rámci projektu se nazývá "**sklonovat**" úložiště. A jakmile jej naklonujeme, všechny úpravy se budou provádět na této kopii v našem místním počítači (většina práce se provádí offline).
|
||||
|
||||
Pro klonování úložiště stačí otevřít terminál, přejít do adresáře, do kterého chceme úložiště klonovat, a spustit příkaz `git clone`, tj. tímto příkazem "řekneme" gitu, aby jej "stáhl". Za příkazem následuje **url adresa** repozitáře, který chceme klonovat. V našem případě by to bylo:
|
||||
|
||||
`git clone https://git.disroot.org/Disroot/Howto`
|
||||
|
||||
Pokud chceme přeložit stránku z **Disroot webu**, pak napíšeme:
|
||||
|
||||
`git clone https://git.disroot.org/Disroot/Website`.
|
||||
|
||||
Poté se proces spustí a za několik minut, v závislosti na našem internetovém připojení, budeme mít repozitář "naklonovaný" na našem počítači.
|
||||
|
||||
![](en/cloning.png)
|
||||
|
||||
Po dokončení tohoto procesu se nám zobrazí adresář `Howto` (nebo `Website`) obsahující všechny soubory webu. Tento adresář můžeme později přesunout na libovolné místo v našem počítači.
|
||||
|
||||
Nyní, než se skutečně pustíme do práce, nastavíme si identitu, abychom mohli nerušeně postupovat vpřed.
|
||||
|
||||
## Nastavení identity
|
||||
Abychom mohli odesílat naši práci z našeho počítače do vzdáleného úložiště, je nutné nastavit naše uživatelské jméno a e-mail. Tyto informace používá systém Git k "podepisování" revizí ("snímků" našich úprav, na to se podíváme později).
|
||||
|
||||
1. Otevřete naklonovanou složku v terminálu.
|
||||
|
||||
2. Type and complete with your information the following commands:<br>
|
||||
`git config --global user.email` **uživatel@email** `<- zde patří vaše emailová adresa`<br>
|
||||
`git config --global user.name` **"jméno"** `<- a zde vaše jméno`
|
||||
|
||||
Nebudeme potřebovat zadávat tyto údaje znovu.
|
||||
|
||||
## Požadavek na přístup k úložišti Disroot
|
||||
Rychlejší a doporučený způsob požádání o přístup přez naši **Howto Chat místnost** na `howto@chat.disroot.org`. Také nám můžete poslat email na adresu `howto@disroot.org`.
|
||||
|
||||
Jakmile vám správci povolí přístup, budete moci "*push*" (odeslat) vaše změny na server.
|
||||
|
||||
!! **POZNÁMKA**<br>
|
||||
!! Můžete začít pracovat bez přístupu jelikož všechny změny se dějí u Vás na počítači a požádat o něj později.
|
||||
|
||||
|
||||
Ok. Pojďme dále.
|
92
pages/04.Contribute/03.styleguide/01.structure/docs.cs.md
Normal file
92
pages/04.Contribute/03.styleguide/01.structure/docs.cs.md
Normal file
|
@ -0,0 +1,92 @@
|
|||
---
|
||||
title: 'General Structure'
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- style
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Obecná struktura
|
||||
|
||||
Web **Howto** se skládá z textových souborů ve formátu Markdown, které jsou obsaženy ve složkách hierarchicky uspořádaných do sekcí.
|
||||
|
||||
Stránka má **tři hlavní adresáře**:
|
||||
- **pages**: tento adresář obsahuje stránky a návody. Jedná se o jediný obsah, který můžeme upravovat a překládat.
|
||||
- **themes**: zde jsou soubory a konfigurace, které utvářejí podobu webu.
|
||||
- **vagrant**: tato složka obsahuje soubory potřebné ke spuštění softwaru Vagrant, který slouží k vytváření virtuálních prostředí.
|
||||
|
||||
Jediný adresář, který nás zajímá pro vytváření, úpravy a překlad howtos, je **pages**.
|
||||
|
||||
![](en/structure.png)
|
||||
|
||||
Jak vidíme na obrázku výše, adresář **stránky** obsahuje několik dalších adresářů a podadresářů.
|
||||
|
||||
- **01.home**: zde se nachází úvodní stránka **Howto**.
|
||||
- **02.tutorials**: v tomto adresáři jsou umístěny všechny návody a jsou uspořádány podle kategorií.
|
||||
- **03.Glossary**: zde je stránka, kde hodláme shromažďovat většinu důležitých pojmů, které používáme prostřednictvím howtos a návodů.
|
||||
- **04.Contribute**: v tomto adresáři najdeme návody, jak vytvářet, upravovat a překládat stránky webu.
|
||||
- **05.Licensing**: licence, pod kterou je obsah stránek uvolněn.
|
||||
- **06.disroot.org**: odkaz na webové stránky **Disroot**.
|
||||
- **Archiv**: tato složka obsahuje všechny návody, které již nejsou online.
|
||||
|
||||
|
||||
# Stránky
|
||||
V současné době existují dvě různé šablony pro stránky **Howto**:
|
||||
- **docs.md**: jedná se o nejběžnější textové soubory, které můžeme najít na webu Howto, tedy stránky, které tvoří howto.
|
||||
|
||||
- **docsparent.md**: tyto stránky slouží k indexování všech **podřízených stránek**, které jsou ve svém **záhlaví** označeny jako `indexed:true`, a vytvářejí nabídku souvisejících stránek. Pokud je ve složce *dceřiné stránky* umístěn obrázek, zobrazí se v indexu jeho miniatura (preferovaná velikost miniatury je 400x300).
|
||||
|
||||
## Záhlaví stránky
|
||||
Záhlaví stránky je místo, kde nastavujeme všechny proměnné pro danou stránku. Je to část, která se zobrazuje nad obsahem uzavřeným mezi třemi pomlčkami `---`.
|
||||
|
||||
Níže je uveden seznam nejčastějších proměnných, které lze zadat v jednotlivých záhlavích, a jejich účel.
|
||||
|
||||
- **title**: je název stránky a bude se zobrazovat v nabídkách a indexech.
|
||||
|
||||
- **subtitle**: zobrazuje se jako položky na domovské stránce.
|
||||
|
||||
- **icon**: ikona Fork-awesome, která se zobrazuje na domovských stránkách.
|
||||
|
||||
- **visible**: nastavuje se pomocí logické hodnoty, *true* nebo *false*. Pokud je u stránek dětí druhého stupně nastavena hodnota false, nezobrazí se v indexu.
|
||||
|
||||
- **indexed**: nastavuje se pomocí logické hodnoty, *pravdivé* nebo *nepravdivé*. Příspěvky nastavené na hodnotu true se zobrazí v indexech nadřazených stránek. Také přidá miniaturu do adresářů stránek, pokud existují (preferovaná velikost miniatury je 400x300).
|
||||
|
||||
- **updated**: je-li zadáno, zobrazí se na stránce informace o metadatech.
|
||||
|
||||
- **published**: nastavuje se pomocí logické hodnoty, *true* nebo *false*.
|
||||
|
||||
- **taxonomy**: slouží k nastavení kategorií a značek. Příspěvky s kategorií 'téma' se zobrazí jako hlavní témata v nabídce domovské stránky.
|
||||
|
||||
- **page-toc**: nastavuje se pomocí logické hodnoty, *true* nebo *false*. Určuje, zda je *Tabulka obsahu* na stránce viditelná, nebo ne. Obvykle se nastavuje na false pro indexové stránky (docsparent.md).
|
||||
|
||||
Abychom lépe pochopili, jak tyto proměnné ovlivňují stránky, můžeme se podívat například na záhlaví indexové stránky **Cloud** (02.Cloud/docsparent.cs.md):
|
||||
|
||||
- _docsparent.md_ na indexové/hlavní stránce
|
||||
|
||||
![](en/docsparent_view.png)
|
||||
|
||||
|
||||
- _docs.md_ header and view at the Cloud howto index (02.Cloud/docsparent.en.md)
|
||||
|
||||
![](en/docs_view.png)
|
||||
|
||||
|
||||
## Meta information
|
||||
|
||||
The meta information is set automatically when specified in the page header under the `updated:` variable. It is necessary to let readers know if the howto is up to date. The fields to complete are:
|
||||
|
||||
`last_modified:` "Month and Year" wrapped between `" "` _(i.e: "June 2020")_<br>
|
||||
`app:` Software name _(i.e: Nextcloud)_<br>
|
||||
`app_version:` Number version of the software _(i.e: 18)_<br>
|
||||
|
||||
### Where to place the Meta information?
|
||||
This information is not necessary in the indexes, but in those pages where there is data that may vary with updates.
|
||||
|
||||
![](en/meta.png)
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
title: 'Information guidelines'
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- style
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Vytvoření informačních pokynů
|
||||
|
||||
## První otázka: O čem můžeme psát?
|
||||
Tato otázka je již částečně zodpovězena na hlavní stránce tohoto webu:
|
||||
> *"Naším cílem je pokrýt všechny služby se všemi funkcemi, které **Disroot** poskytuje, pro všechny platformy a/nebo operační systémy, jakož i co největší počet klientů pro nejrozšířenější zařízení "*
|
||||
|
||||
Můžeme tedy psát o softwaru poskytovaném společností **Disroot**, o tom, jak fungují a co s nimi můžeme dělat. To se zdá být zcela zřejmé, dokud si nepoložíme otázku, zda všichni používáme ve svých počítačích nebo mobilních zařízeních stejný operační systém.
|
||||
|
||||
Skutečnost, že se zaměřujeme výhradně na používání, propagaci a šíření **svobodného a otevřeného softwaru** (a proto jsou naše návody psány především pro GNU/Linux), by nás neměla přimět k tomu, abychom zapomněli, že existuje mnoho lidí, kteří se rozhodli používat proprietární software a jejich přístup k našim službám nesouvisí s etickými nebo politickými důvody, ale s pragmatickými.
|
||||
|
||||
Proto výslovně říkáme:
|
||||
|
||||
V tomto případě je to zřejmé z toho důvodu, že se jedná o zásadní požadavek: > *"pro všechny platformy a/nebo operační systémy, jakož i pro co největší počet klientů pro nejrozšířenější zařízení "*.
|
||||
|
||||
Základní seznam hlavních operačních systémů, které se snažíme pokrýt, je následující:
|
||||
|
||||
- **GNU/Linux**, **Microsoft Windows** a **Apple macOS** na stolních a přenosných počítačích a
|
||||
- **Google Android**, **Apple iOS**, **Jolla Sailfish OS** a **Microsoft Windows Mobile** na mobilních zařízeních.
|
||||
|
||||
!! **Každý, bez ohledu na operační systém, který používá, může spolupracovat tím, že napíše, jak službu používat. Nezapomeňte, že nejdůležitější je zpřístupnit informace komukoli**.
|
||||
|
||||
## Druhá otázka: Pro koho jsou návody určeny?
|
||||
V zásadě může služby **Disroot** používat každá osoba starší 16 let. Můžeme však myslet i na to, že každý z nás má například příbuzné a známé, které by rád seznámil s používáním společensky etických a technicky užitečných nástrojů, nebo to třeba chtějí udělat sami.
|
||||
|
||||
Při psaní návodu na použití tedy musíme myslet na to, že informace musí být srozumitelné komukoli bez ohledu na věk nebo technické znalosti. Samozřejmě vždy existují programy, které jsou složitější než jiné, ale to by nemělo znamenat, že se nebudeme snažit, aby se je mohl naučit kdokoli.
|
||||
|
||||
To vede k následující otázce.
|
||||
|
||||
## Třetí otázka: Jaký typ jazyka bychom měli používat?
|
||||
Aby byly návody co nejpřístupnější nejen uživatelům, ale i těm, kteří nám pomáhají s jejich překladem, musíme používat angličtinu v co nejméně neformální podobě. To znamená vyhnout se používání odborného žargonu, slangu nebo jazykových zkratek (například je vhodnější psát "nebude" místo "nebude"). Musíme mít také na paměti, že tyto příručky by mohly být použity nebo přeloženy jinými projekty, které poskytují podobné služby nebo software, a chceme, aby jim úkol jejich úpravy zabral co nejméně času.
|
||||
V případech, kdy se nevyhneme použití odborných termínů, musíme stručně vysvětlit jejich význam nebo odkázat na externí zdroj (např. článek na Wikipedii), který tak učiní.
|
||||
|
||||
## Čtvrtá otázka: Pokud jde o překlady, měly by být doslovné?
|
||||
Ačkoli neexistuje konkrétní a účinná metoda, existují přinejmenším dvě důležité věci, které bychom měli mít při překladu na paměti.
|
||||
1. **Pochopit text návodu k použití integrálně**. Než začneme překládat, je vhodné si celý text přečíst a "zachytit" jeho podstatu: "o čem je", "jak jsou informace prezentovány a/nebo strukturovány", "je těžké/snadné je pochopit" atd. To nám pomůže identifikovat kontext slov a výrazů, které se v daném dokumentu objevují a jejichž význam na něm závisí.
|
||||
2. **Sledování původního textu je zásadní, stejně jako zachování jeho plynulosti**. Někdy bychom mohli narazit na slova nebo výrazy, které jsou do našeho jazyka opravdu těžko přeložitelné nebo dokonce nepřeložitelné. Musíme si tedy dávat pozor, abychom je nevynechali nebo příliš nezměnili jejich původní význam, protože to může ovlivnit celkové vyznění řádku, odstavce nebo celého dokumentu. Pokud máme pochybnosti o některých úpravách, můžeme se vždy poradit nebo zeptat v chatu Howto.
|
||||
|
||||
Doslovnost překladu tedy nemusí vždy vést k souvislému textu. Pokud je nutné provést úpravy výrazů nebo slov, musí být co nejvěrnější původnímu významu dokumentu.
|
||||
|
||||
A konečně, před odesláním překladu je vždy třeba provést jeho korekturu. Velmi často se totiž objevují drobné opakující se chyby nebo nesrovnalosti a jejich včasná oprava zabrání tomu, aby nám byl překlad vrácen.
|
|
@ -0,0 +1,262 @@
|
|||
---
|
||||
title: 'Zásady vzhledu'
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- style
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Pokyny pro vzhled obsahu
|
||||
|
||||
Stejně jako u informací, i při zařazování vizuálního obsahu musíme dodržovat určitá kritéria, aby návod byl především didaktický a užitečný. Mějte na paměti, že někdy příliš mnoho obrázků může způsobit, že se přestaneme soustředit na informace a výsledkem bude poněkud nepřehledný dokument. Nemluvě o tom, že to může zbytečně prodloužit dobu načítání stránky.
|
||||
|
||||
Takže první, co musíme udělat, je vyhodnotit, které základní vizuální pomůcky je třeba zahrnout. Například najít nabídku nebo konfiguraci, popsat akce, způsob jejich provedení nebo porovnat účinky jejich provedení.
|
||||
|
||||
# Obecná kritéria
|
||||
Obecně řečeno, vizuální obsah návodu k použití by pak měl splňovat následující kritéria:
|
||||
|
||||
1. **Použití vizuálních pomůcek** _(kdykoli je to možné)_ **jako například**:
|
||||
- snímky obrazovky
|
||||
- Obrázky ve formátu GIF / videozáznamy z počítače nebo mobilního telefonu
|
||||
|
||||
* Doporučený software: * V případě, že se jedná o videokameru, můžete použít např:
|
||||
- [**Peek**](https://github.com/phw/peek): animovaný záznam GIF (počítač).
|
||||
- [**ScreenCam**](https://f-droid.org/en/packages/com.orpheusdroid.screenrecorder/): záznam obrazovky (telefon).
|
||||
- [**scrcpy**](https://github.com/Genymobile/scrcpy): záznamník mobilní obrazovky (počítač)
|
||||
|
||||
2. **Snadno se přizpůsobí dalším projektům**: Za tímto účelem by měly být zmínky o **Disroot** a další jedinečné identifikátory projektu **Disroot** omezeny na nezbytné minimum a obsah by měl být co nejobecnější a bez přídavných jmen. Tímto způsobem bude pro ostatní projekty snazší howtos používat, přizpůsobovat a upravovat.
|
||||
|
||||
3. **Konkrétní textový obsah**: Pište pouze to, co je nezbytné k vysvětlení úkolu nebo funkce, a upozorněte na důležité věci, které by uživatelé měli vědět, například pomocí "upozornění" (viz níže).
|
||||
|
||||
4. **Vyhněte se dlouhým odstavcům textu**
|
||||
|
||||
5. **Při popisu několika kroků nebo funkcí používejte místo velkých odstavců odrážky**.
|
||||
|
||||
6. **Vyhněte se používání tabulek, pokud neslouží k jinému účelu než k formování textu**.
|
||||
|
||||
## Používání "Upozornění":
|
||||
"Upozornění" jsou malé části textu, které můžeme použít ke zdůraznění důležitých informací, například ke zdůraznění něčeho, co by uživatelé měli mít na paměti nebo čeho by si měli být vědomi, když něco konfigurují nebo než provedou nějakou akci.
|
||||
|
||||
Pro formátování oznámení musíme text začít dvěma vykřičníky `!!`.
|
||||
|
||||
Například:
|
||||
```
|
||||
!! **POZNÁMKA!** toto je příklad důležité informace.
|
||||
```
|
||||
|
||||
bude vypadat takto:
|
||||
!! **POZNÁMKA!** toto je příklad důležité informace.
|
||||
|
||||
#### Vložené obrázky
|
||||
|
||||
Obrázky jsou ve výchozím nastavení vycentrovány do dalšího řádku. Chcete-li použít obrázek inline, tedy na stejném řádku věty, použijte hned za ním {.inline}. Jako v tomto příkladu:
|
||||
|
||||
```
|
||||
![](en/07_share_button.png) {.inline}
|
||||
```
|
||||
----------------------------------------------------------------------
|
||||
|
||||
|
||||
# Markdown: Několik tipů pro formátování
|
||||
|
||||
Jak jsme se již zmínili, [How-to Website](https://howto.disroot.org/) **Disroot** je vytvořen pomocí [Grav](https://getgrav.org/) a jako značkovací/formátovací jazyk pro tvorbu textu používá **Markdown**, protože je lehký a jeho syntaxe se snadno učí.
|
||||
|
||||
Níže najdete několik tipů a doporučení týkajících se formátování textu výukového programu.
|
||||
|
||||
## Nadpisy
|
||||
|
||||
Samotný titulek návodu se umisťuje do záhlaví stránky, můžete jej upravit, pokud používáte git.
|
||||
|
||||
Co se týče názvů jednotlivých částí návodu, můžete je v jazyce Markdown sestavit pomocí symbolu `#` a mezery před samotným názvem. Například:
|
||||
|
||||
Při psaní tohoto...
|
||||
```
|
||||
# Nadpis 1
|
||||
## Nadpis 2
|
||||
### Nadpis 3
|
||||
#### Nadpis 4
|
||||
##### Nadpis 5
|
||||
```
|
||||
...se zobrazí jako:
|
||||
|
||||
# Nadpis 1
|
||||
## Nadpis 2
|
||||
### Nadpis 3
|
||||
#### Nadpis 4
|
||||
##### Nadpis 5
|
||||
|
||||
Čím více `#` použijete, tím menší bude nadpis.
|
||||
|
||||
Nadpisy jsou důležité z několika důvodů. Jedním z hlavních je, že je Grav používá k automatickému generování TOC (Table of Content) stránky. Lze je tedy použít k zobrazení jednotlivých kapitol / částí návodu na začátku indexu stránky.
|
||||
|
||||
|
||||
|
||||
Menší tituly se v TOC zobrazují jako "podkapitoly". To by mohlo být užitečné k něčemu takovému:
|
||||
|
||||
Doporučujeme používat jeden `#` pro hlavní název stránky a dva `##` pro podkapitoly. Můžete použít `###` nadpisy pro menší nadpisy v textu, které chcete mít v TOC, a ještě menší nadpisy pro nadpisy, které v TOC být nemusí.
|
||||
|
||||
|
||||
## Seznamy
|
||||
|
||||
Používejte seznamy pro výčet kroků nebo funkcí v návodu k použití.
|
||||
|
||||
Vytvořte si body s odrážkami, což je snadné. Writing...
|
||||
```
|
||||
Můj seznam:
|
||||
- něco 1
|
||||
1. dílčí položka 1
|
||||
2. dílčí položka 2
|
||||
- něco 2
|
||||
```
|
||||
... zobrazí toto:
|
||||
|
||||
Můj seznam:
|
||||
- něco 1
|
||||
1. dílčí položka 1
|
||||
2. dílčí položka 2
|
||||
- něco 2
|
||||
|
||||
|
||||
## Tučně
|
||||
|
||||
Použijte tučné písmo pro zvýraznění:<br>
|
||||
- Důležité informace
|
||||
- Upozornění uživatelům
|
||||
- Nebo menší název uvnitř oddílu, který není nutné uvádět v TOC.
|
||||
|
||||
Pro zvýraznění slova nebo řádku tučným písmem použijte dva symboly `*` před a za potřebnou částí.<br> Například pokud napíšete...
|
||||
|
||||
`**Něco**`
|
||||
|
||||
bude zobrazeno jako:
|
||||
|
||||
**Něco**
|
||||
|
||||
|
||||
## Italic
|
||||
|
||||
Kurzíva funguje podobně jako tučné písmo. Můžete použít `_` symbol nebo jednu `*` před a za slovem, nebo částí textu pro kterou chcete použít kurzívu.<br>
|
||||
Příklady:<br>
|
||||
Psaní...<br>
|
||||
|
||||
`_příklad_`<br>
|
||||
`*příklad*`
|
||||
|
||||
... zobrazí toto:
|
||||
|
||||
_příklad_<br>
|
||||
*příklad*
|
||||
|
||||
|
||||
## Odkazy
|
||||
|
||||
Někdy potřebujeme vložit odkazy na nějaké stránky, nebo webové stránky. Lze to udělat tímto způsobem:
|
||||
|
||||
Napsáním `[odkaz na webové stránky Disroot](disroot.org)`
|
||||
|
||||
bude zobrazeno jako:
|
||||
|
||||
[odkaz na webové stránky Disroot](disroot.org)
|
||||
|
||||
|
||||
## Vložení videa / gifů / snímků obrazovky do návodu na použití
|
||||
|
||||
Jak už jsme se zmínili, máme rádi obrázky / videa v návodech. Můžete je vložit následujícím způsobem:
|
||||
|
||||
- Za prvé: Vytvořte složku, kam videa / gify / obrázky umístíte.
|
||||
- Za druhé: Pojmenujte soubory podle pořadí, v jakém se budou v návodu objevovat.
|
||||
|
||||
Poté vytvořte odkaz s cestou ke složce a názvem daného souboru.<br>
|
||||
Pokud tedy napíšete...
|
||||
|
||||
`![](název_složky_plné_mediálních_souborů/příklad_1.png)`
|
||||
|
||||
... zobrazí se toto:
|
||||
|
||||
![](cs/název_složky_plné_mediálních_souborů/příklad_1.png)
|
||||
|
||||
A když uděláte toto:
|
||||
|
||||
Text před ![]( název_složky_úplné_soubory_médií/příklad_1.png) Text za`.
|
||||
|
||||
dostanete toto:
|
||||
|
||||
text před ![](cs/jméno_adresáře_plné_mediální_soubory/příklad_1.png) text po
|
||||
|
||||
Výše popsaná struktura funguje také pro vkládání gifů a videí .mp4.
|
||||
|
||||
|
||||
## Kód
|
||||
|
||||
Pokud potřebujete zobrazit některé terminálové příkazy, řádky kódu, instrukce nebo příklady, jako jsme to dělali v této příručce, můžete použít symbol **`** před a za textem, který chcete zobrazit.<br>
|
||||
Například:<br>
|
||||
|
||||
Toto je příkaz příkazového řádku: `sudo apt update`
|
||||
|
||||
# Terminologie
|
||||
|
||||
Aby byly návody ucelenější a daly se snáze přizpůsobit dalším skupinám, doporučujeme používat následující kritéria:
|
||||
|
||||
- Při psaní návodu k použití by měl být název **Disroot** uváděn jako: **Disroot**, začínající velkým písmenem a tučným písmem.
|
||||
|
||||
- A na jednotlivé služby odkazovat takto:
|
||||
|
||||
|Název služby|Disroot|
|
||||
|-:|:-|
|
||||
|Lufi|**Disroot Upload**|
|
||||
|Forum/Discourse|**Disroot Forum**|
|
||||
|Etherpad|**Disroot Pad**||
|
||||
|XMPP|**Disroot Chat**|
|
||||
|Emailové služby obecně|**Disroot Email**|
|
||||
|Rainloop|**Disroot Webmail**|
|
||||
|Private Bin|**Disroot Bin**|
|
||||
|Nextcloud:|**Disroot Cloud**|
|
||||
|Nextcloud Calendar App|**Disroot Calendar**|
|
||||
|Nextcloud Notes App|**Disroot Notes**|
|
||||
|Nextcloud Contacts App|**Disroot Contacts**|
|
||||
|
||||
Takto, pokud jsou výrazy regulární, je jednodušší udělat jen "*Vyhledat a nahradit*" :wink:
|
||||
|
||||
|
||||
# Video návod
|
||||
|
||||
U video návodů si také myslíme, že obsah by měl být **zachován na minimální úrovni** a **krátký** natolik, aby uživatel mohl úkol splnit a aby byl přehledný.
|
||||
|
||||
Stejně jako textové návody by měly mít návody následující strukturu:
|
||||
|
||||
1. **Meta informace**
|
||||
2. **Obsah**
|
||||
3. **Licenční informace**
|
||||
|
||||
**Metadata** a **licenční informace** budou umístěny správci **Disroot** do popisu videa v instanci Peertube, kde budou videa umístěna.
|
||||
|
||||
## Popis obsahu
|
||||
|
||||
Videa by měla v maximální možné míře obsahovat:
|
||||
|
||||
- Název návodu na použití
|
||||
- Stručný popis toho, čeho se týká
|
||||
- Verze softwaru, kterého se týká
|
||||
|
||||
Tak, aby je správci **Disroot** mohli umístit do popisu videa v instanci Peertube.
|
||||
|
||||
## Obsah
|
||||
|
||||
## Licence na video návody k použití
|
||||
|
||||
Jak jsme již zmínili, informace o licencování umístí administrátoři **Disroot** do popisu videa.
|
||||
|
||||
Doporučujeme však, abyste na konec videa umístili následující obrázek, který bude asi 10 vteřin mizet:
|
||||
|
||||
![](en/licensing-pic.png)
|
||||
|
||||
V takovém případě, pokud bude video staženo a znovu nahráno na jiné místo, budou informace o licenci stále k dispozici.
|
||||
|
||||
---
|
21
pages/04.Contribute/03.styleguide/02.content/docs.cs.md
Normal file
21
pages/04.Contribute/03.styleguide/02.content/docs.cs.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: 'Pokyny k obsahu'
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- style
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Pokyny k obsahu
|
||||
Nepochybně existuje několik způsobů, jak napsat nebo přeložit průvodce. A pokud budeme hledat na internetu, najdeme nejrůznější styly: od velmi odborných až po některé velmi vtipné, projdeme přes některé docela nudné, některé vizuálně působivé a jiné určitě spartánské ve více než jednom ohledu. Všechny však mají jedno společné: **informace**. To je naše surovina.
|
||||
|
||||
Cílem projektu **Howto** je poskytovat ne ledajaké informace, ale užitečné informace o softwaru dostupném na platformě **Disroot**, a to co nejsrozumitelnějším a nejpřístupnějším způsobem. Jak toho ale dosáhnout?
|
||||
|
||||
No, můžeme si položit několik otázek a zjistit, zda můžeme společně sestavit nějaké definice, které by nás v tomto úkolu vedly.
|
29
pages/04.Contribute/03.styleguide/docs.cs.md
Normal file
29
pages/04.Contribute/03.styleguide/docs.cs.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
title: 'Jak přispět: Příručka stylu'
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
- style
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
# Příručka stylu
|
||||
|
||||
![](h2_guide.jpg)
|
||||
|
||||
Účelem této části je poskytnout několik obecných pokynů, které je třeba mít na paměti při psaní nebo překladu návodu pro **Disrootův [How-to site](https://howto.disroot.org)** a zachovat tak určitou soudržnost struktury dokumentace, a to jak po vizuální, tak po písemné stránce.
|
||||
|
||||
|
||||
---
|
||||
# Obsah
|
||||
- ### [Struktura](structure)
|
||||
Adresáře a stránky
|
||||
|
||||
- ### [Obsah](content)
|
||||
Psaní, překlady a vizuální obsah
|
34
pages/04.Contribute/docs.cs.md
Normal file
34
pages/04.Contribute/docs.cs.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
název: Jak přispět
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- contribute
|
||||
page-toc:
|
||||
active: false
|
||||
---
|
||||
|
||||
# Přispět
|
||||
|
||||
![](contribute.jpg)
|
||||
|
||||
Domníváme se, že znalosti jsou kolektivní konstrukcí: výsledkem společné práce a spolupráce jako společenství. A ať už mají příspěvky podobu daru, psaní/překladu návodu nebo hlášení chyb, všechny jsou v podstatě osobním časem věnovaným ostatním. Trochu jako láska.
|
||||
|
||||
Hlavním cílem této části projektu **Disroot** je poskytovat jasné a přístupné informace o tom, jak používat a konfigurovat nabízené služby, a navíc tak činit v co největším počtu jazyků.
|
||||
Skládá se převážně z návodů a tutoriálů, které se vyvíjejí spolu s vývojem softwaru. Proto stále hledáme pomoc při kontrole, psaní a překládání návodů.
|
||||
|
||||
Proto jsme se pro ty z vás, kteří by chtěli přispět věnováním svého času a know-how, pokusili nasměrovat veškeré úsilí prostřednictvím této sekce.
|
||||
|
||||
Zde najdete základní informace a pokyny k různým způsobům, jak přispět, od zpětné vazby až po napsání how-to nebo jejich překlad do vašeho jazyka.
|
||||
|
||||
---
|
||||
|
||||
# Obsah
|
||||
|
||||
## - [Howto Postup a nástroje](procedure)
|
||||
## - [Git: konfigurace a nastavení](git)
|
||||
## - [Práce s textovým editorem](git/editors)
|
35
pages/05.Licensing/docs.cs.md
Normal file
35
pages/05.Licensing/docs.cs.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: How-to: Licence
|
||||
published: true
|
||||
visible: true
|
||||
updated:
|
||||
taxonomy:
|
||||
category:
|
||||
- docs
|
||||
tags:
|
||||
- licence
|
||||
page-toc:
|
||||
active: false
|
||||
---
|
||||
|
||||
# Licencování tutoriálů
|
||||
![](en/copyleft.png)
|
||||
|
||||
Veškerá dokumentace na webu je pod <br><a rel="licence" href="http://creativecommons.org/licenses/by-sa/4.0/deed.cs">Creative Commons Attribution-ShareAlike 4.0 Mezinárodní licence</a><br><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png"/>
|
||||
<br>
|
||||
|
||||
Myslíme si, že znalosti by se měly sdílet, a proto jsme se rozhodli, že všechny dokumenty na stránce **Disroot Howto** zpřístupníme ostatním, aby je mohli použít a vylepšit nebo přizpůsobit svým potřebám.<br>
|
||||
Také si myslíme, že dokumentace, kterou na této stránce píšeme o tom, jak používat naše služby, by mohla být užitečná pro jiné poskytovatele služeb **svobodného a otevřeného softwaru** a/nebo jednotlivce, kteří používají stejný software a/nebo sdílejí stejnou etickou volbu jako **Disroot**.
|
||||
|
||||
Použitím licence **Creative Commons** dáváme veřejně najevo, že veškerou dokumentaci (návody) zveřejněné na adrese [howto.disroot.org](https://howto.disroot.org) lze volně upravovat, vylepšovat, šířit a/nebo sdílet.
|
||||
|
||||
**Proto žádáme všechny, kteří chtějí přispět novým návodem na naši stránku [How-to](https://howto.disroot.org), aby souhlasili s jeho zveřejněním pod licencí Creative Commons BY-SA**.
|
||||
|
||||
Licence **Creative Commons BY-SA** umožňuje komukoli návod volně upravovat a sdílet, pokud jsou podmínky zveřejnění v souladu s následujícími podmínkami:
|
||||
- uznání úpravy a odkazů na původní dílo a/nebo autora.
|
||||
- Sdílení upravené verze se stejnou licencí (BY-SA), která umožňuje ostatním dílo také sdílet a upravovat.
|
||||
|
||||
|
||||
Více informací o konceptu **Copyleft** si můžete přečíst [zde](https://cs.wikipedia.org/wiki/Copyleft).
|
||||
|
||||
A více o **licencích Creative Commons** [zde](https://creativecommons.org/).
|
Loading…
Reference in a new issue