1. WIKI done.pl
  2. Workflow
  3. Nowa wiki done

Nowa wiki done

Wiki jest utrzymywana na repozytorium gita done/wiki

  • pliki pisane są w składni markdown, przykłady składni github, (składnia działa również w gitlabie, w opisach komentarzach itd. Gitlab na dodatkowo własne rozszerzenie Markdown GFM)
  • można ją pobrać i postawić lokalnie (komenda vendor/bin/bookdown docs/bookdown.json)
  • zmiany dokonywane są prze repozytorium git, wszelkie zmiany tylko przez "merge request"
  • wszelkie dyskusje, błedy odnośnie wiki proszę wrzucać na done/wiki/issues

Wiki jest aktualizowana automatycznie po akceptacji "merge request".

W celu sprawdzenia kodu "strony" w wiki można także kliknąć w prawym górnym rogu na przekierowanie do gitlab

Dodanie nowej podstrony

Obecnie znajdujemy się w "Workflow", wszystkie podstony z tej zakładki znajdują się na repozytorium pod scieżką docs/workflow np docs/workflow/wiki.md. Dodanie nowej podstrony polega na:

  1. dodaniu pliku np. docs/workflow/nowa_strona.md
  2. edycji spisu treści docs/workflow/bookdown.json:
#plik: docs/workflow/bookdown.json
{
 "title": "Workflow",
 "content": [
   {"wiki": "wiki.md"},
   ...
   {"nowa_strona": "nowa_strona.md"}, # <---- zmiana 
   ...
   {"new_project": "new_project.md"},
   {"gitlab_ci": "gitlab_ci.md"},
   {"deployer": "deployer.md"}
 ],
 "tocDepth": 1
}

Edycja

Edycja ogranicza się do zmiany pliku, można skorzystac z gitlab lub pobra projekt i edytować plik

Dodanie nowej zakładki

Nowe zakładki można dodawać tworząc podobną strukturę co workflow czyli

Tworzymy scieżkę np docs/NOWAZAKLADKA W scieżce dodajemy plik np docs/NOWAZAKLADKA/intro.nd z dowolną zawartością, musimy dodatkowo utworzyć "definicje zakładki" w pliku docs/NOWAZAKLADKA/bookdown.json :

#plik: docs/NOWAZAKLADKA/bookdown.json
{
 "title": "NOWAZAKLADKA",
 "content": [
   {"intro": "intro.md"},
 ],
 "tocDepth": 1
}

Na koniec musimy dodać zakładkę (jej definicję) do głównego pliku docs/bookdown.json:

#plik: docs/bookdown.json
"title": "WIKI done.pl",
   "content": [
       {"tutorial": "workflow/bookdown.json"}
       {"NOWAZAKLADKA": "NOWAZAKLADKA/bookdown.json"}  # <---- zmiana 
   ],
   "theme": {
       "toc": {
           "collapsibleFromLevel": 3
       }
   },
   "tocDepth": 3,
   "template": "../template/main.php",
   "target": "./html",
   "numbering": false,
   "extensions": {
       "commonmark": [
           "Webuni\\CommonMark\\TableExtension\\TableExtension",
           "Webuni\\CommonMark\\AttributesExtension\\AttributesExtension"
       ]
   }

Każdą z powyższych czynności należy zakończyć merge requestem do mastera :)

W razie wątpliwości zachęcam do pobrania i postawienia projektu wiki i sprawdzenia co i jak wygląda/działa.

git clone git@ultra3.done.pl:done/wiki.git
cd wiki
composer install
vendor/bin/bookdown docs/bookdown.json
php -S localhost:8000 -t docs/html
firefox localhost:8000

FAQ

Każdy dział będzie miał FAQ z waszymi pytaniami i odpowiedziami na nie. :) chyba, że ktoś się zlituje i zmieni pytanie z odpowiedziała na jakiś fajny kawałek dokumentacji :))

Edit on GitLab