Wiki.js hosting: documentatie die naast je code leeft.
Pagina's in Markdown, op te slaan in een Git-repository. Wij hosten Wiki.js en houden het bij.
Kort antwoord
Wiki.js is een wiki voor technische teams. Pagina's schrijf je in Markdown, de inhoud kan worden gesynchroniseerd met een Git-repository, en je vindt alles terug met de zoekfunctie. Aanmelden kan op veel manieren. Wij hosten Wiki.js in Nederland op onze eigen servers en doen het onderhoud. Het kan Confluence of GitBook vervangen voor teams die documentatie bij hun code willen houden.
Wiki.js of BookStack
| Onderwerp | Wiki.js | BookStack |
|---|---|---|
| Schrijven | Markdown, met voorbeeld ernaast | Een editor die op een tekstverwerker lijkt |
| Opbouw | Pagina's in een boomstructuur die je zelf kiest | Vaste lagen: planken, boeken, hoofdstukken, pagina's |
| Git | De inhoud kan met een repository worden gesynchroniseerd | Niet het uitgangspunt |
| Inloggen | Veel methoden, waaronder single sign-on | Ook single sign-on, met minder keuze |
| Past bij | Ontwikkelaars en beheerders | Collega's zonder technische achtergrond |
We hosten beide. Het meest voorkomende misverstand is dat een wiki voor het hele bedrijf in Markdown moet. Dat kan, maar de meeste collega's schrijven liever in een gewone editor.
Documentatie die niet verouderd raakt
Documentatie veroudert op het moment dat ze op een andere plek staat dan de code. Wie de code wijzigt, opent de wiki niet. Daar kun je iets aan doen door de pagina's naast de code te bewaren, in dezelfde Git-repository, met dezelfde controle voordat iets live gaat.
Wiki.js maakt dat mogelijk: schrijven kan in de wiki zelf, of in de repository, en de twee worden bij elkaar gehouden. Of je dat wilt, hangt af van hoe je team werkt. Heb je geen repository om aan te koppelen, dan is Wiki.js ook gewoon een goede wiki.
Feiten over Wiki.js
- Licentie
- AGPL 3.0. Wiki.js is een merknaam van zijn maker en Jevana is geen partij in het project.
- Vervangt
- Confluence en GitBook
- Schrijven
- In Markdown
- Git
- Inhoud kan met een repository worden gesynchroniseerd
- Inloggen
- Met veel verschillende methoden, ook via je bestaande accounts
- Ons werk
- Installeren, updates volgen, een back-up per dag met een extra kopie elders, en de server in de gaten houden
Veelgestelde vragen
Voor wie is Wiki.js bedoeld?
Voor technische teams die documentatie willen schrijven in Markdown en die bij de code willen houden. Denk aan beheerders die runbooks bijhouden, en ontwikkelaars met interne handleidingen. Een team zonder technische achtergrond kan er ook mee werken, maar heeft meer aan een editor die op een tekstverwerker lijkt, zoals die van BookStack.
Wat betekent synchronisatie met Git bij Wiki.js?
De pagina's kunnen als bestanden in een Git-repository staan, en wijzigingen in de wiki en in de repository worden naar elkaar overgenomen. Zo heb je de geschiedenis en het controleproces van Git ook voor je documentatie. Welke repository je gebruikt, bespreken we vooraf. Dat kan de Forgejo-omgeving zijn die wij ook beheren, of een andere.
Kunnen we anderen laten meelezen zonder ze te laten schrijven?
Ja. Je regelt per groep wie pagina's mag lezen, schrijven of beheren, en je kunt hele delen van de wiki afschermen. Een gedeelte kan zichtbaar zijn voor klanten, terwijl de interne documentatie daarachter blijft. Inloggen kan met een bestaand account, zodat je geen aparte gebruikers hoeft aan te maken.
Wat gebeurt er met onze pagina's als we naar een ander systeem willen?
Omdat de pagina's Markdown zijn, zijn ze gemakkelijk mee te nemen. Als je Git-synchronisatie gebruikt, staan ze al als bestanden in jouw eigen repository, los van onze server. Anders leveren we een export van alle pagina's en afbeeldingen. Markdown opent in vrijwel elk ander systeem, dus de inhoud blijft bruikbaar.
Past hier ook bij
-
Paperless-ngx
Een documentarchief dat scans leest, ordent en terugvindt. De originelen blijven bewaard.
-
OpenProject
Projectmanagement met taken, planning, boards en uren, voor teams die geen Jira willen.
-
Forgejo
Git-hosting en CI/CD voor ontwikkelteams, open source en op onze eigen hardware.
-
BookStack
Een interne wiki voor handboeken en werkinstructies, voor teams die geen techneut zijn.
Vertel wat er bij jullie draait.
Een kennismaking kost niets. Je praat meteen met een van de twee mensen die het werk daarna ook echt doen.
of mail naar info@jevana.systems