Lägg till och redigera nya artiklar till datorhandboken
Utvecklingsmiljön
- Klona ner handboksrepot härifrån med
git clone https://git.lysator.liu.se/littlefox/lysdoc.git
- Navigera till toppen av den nedhämtade katalogen och kör
python3 -m venv venv
- Kör
source venv/bin/activate
för att aktivera python miljön. - Kör
pip install -r requirements.txt
för att installera alla beroenden. - Byt mapp till
lysdocs/
- Kör kommandot
mkdocs serve
för att serva sidan lokalt. - Mer information om mkdocks går att hitta på https://squidfunk.github.io/mkdocs-material/
Sidredigering
- Checka ut en egen gren med
git checkout -b *<namn på din gren>*
. - Gör dina önskade ändringar, spara dem med
git add *<filnamn>*
ochgit commit
. - Tryck upp dina önskade ändringar till gitlab med
git push
och logga in på https://git.lysator.liu.se/littlefox/lysdoc för att skapa en merge request. - Din request ses över och mergas till eller nekas från master.
Skapa nya sidor
- Se ovan instruktioner.
- Skapa din markdown fil på önskad plats.
- Öppna
docs/tillstånd.md
- Lägg till
under relevant kategori.
<td style="background-color:[röd/orange/grön]"><a href="../sök/väg/till/filen">filnamnet</a></td>
Skapa nya kategorier
- Lägg till en mapp under
docs/guider
ellerdocs/rootmanual
namngiven efter din önskade kategori. - lägg till den på statushemsidan genom att lägga till
i
<tr> <th><a href="../väg/till/mapp">mappnamnet</a></th> [Status på och sökväg till din fil] </tr>
docs/tillstånd.md