Hulp vinden en zien wat er veranderde

Deze handleiding zit ín het paneel: je hoeft er niet voor naar een andere website, en hij werkt ook als je offline op je telefoon kijkt. Dezelfde teksten staan bovendien op een openbare site, zodat je een link kunt sturen aan iemand die (nog) geen account heeft. Deze pagina legt uit waar hulp staat, hoe je zoekt, en waar je ziet wat er in het paneel is veranderd.

Waar hulp staat

Op elke pagina, altijd op dezelfde plek:

• Hulp bij deze pagina — het icoon rechtsboven, of gewoon de toets ?. Er schuift een paneeltje open met precies het artikel dat over het scherm gaat waar je op staat. Onderaan staat Open de volledige handleiding, als je liever met de navigatie ernaast verder leest.
• Handleiding — onderin het zijmenu en rechtsboven. Dat is het overzicht van alle onderwerpen.
• ⌘K (of Ctrl+K) opent het commandopalet. Dat doorzoekt de navigatie én de handleiding tegelijk: typ "mailbox" en je krijgt zowel de pagina als het artikel.

Hoe een artikel eruitziet

Een artikel heeft drie kolommen, en elk van de drie doet iets:

• links de onderwerpen. De groep waar je in zit staat open en het artikel dat je leest is gemarkeerd, dus je ziet altijd waar je bent.
• midden de tekst, in een vaste leesbreedte. Dat is met opzet niet de volle schermbreedte: een regel van 150 tekens is precies waarom lange documentatie vermoeiend leest.
• rechts Op deze pagina, met de kopjes van het artikel. Terwijl je scrollt licht het kopje op waar je nu bent. Op een smal scherm valt deze kolom weg en wordt de linkerkolom een uitklapbaar menu.

Boven de tekst staat het pad (Handleiding › onderwerp › artikel) en onderaan staan Vorige en Volgende, zodat je een onderwerp in één ruk kunt doorlezen.

Codeblokken hebben een kopieerknop; blokken die een transcriptie zijn (het commando met de uitvoer eronder) niet, want die kopieer je toch niet.

Zoeken

Het zoekveld boven de handleiding doorzoekt alle artikelen: de titels, de kopjes en de tekst zelf. Meerdere woorden werken als "allemaal aanwezig", dus wordpress staging vindt de pagina die over allebei gaat en niet elke pagina die WordPress noemt. Vindt hij niets, dan zegt hij dat — je krijgt geen lijst met alles alsof je niets had ingetypt.

Het zoeken gebeurt in je browser. Er gaat niets naar een zoekdienst en er is niets dat eerst opgehaald moet worden: de handleiding zit in het paneel zelf.

Je ziet de artikelen die bij jou horen

De handleiding filtert zichzelf op jouw soort account:

• ben je een hostingklant, dan zie je de artikelen voor klanten;
• ben je reseller, dan zie je die van je klanten er ook bij — want jij beantwoordt hun vragen;
• ben je beheerder, dan zie je alles.

Rechtsboven de handleiding staat een keuzelijst waarmee je dat kunt omzetten: Toon alles, of Bekijk als klant om te zien wat jouw klanten zien. Handig als je iemand aan de telefoon hebt.

Open je een artikel dat voor een hoger niveau is geschreven, dan krijg je geen "pagina bestaat niet", maar het artikel met een blok erboven dat zegt voor wie het geschreven is en wat je kunt doen. Dat is eerlijker dan doen alsof de uitleg niet bestaat.

Nederlands en Engels

Elk artikel bestaat in beide talen. Wissel je van taal, dan blijf je op hetzelfde artikel staan — je springt niet terug naar het overzicht. Je taalkeuze staat in Instellingen.

De openbare handleiding

Dezelfde artikelen staan openbaar op docs.corecp.dev, zonder inloggen. Dat is de link die je aan een klant of aan iemand die nog geen account heeft kunt sturen. De openbare site draagt de huisstijl van het merk waarvan je de hostnaam gebruikt: heeft je hostingpartij een eigen naam en kleur, dan staat die daar ook.

# Elk artikel heeft een vaste, deelbare link, per taal:
curl -sI https://docs.corecp.dev/nl/e-mail-instellen | head -1
curl -sI https://docs.corecp.dev/en/setting-up-email | head -1

Wat er veranderde

Onder Wat is er veranderd (of via de versie onderin het zijmenu) staan de release-notities. Links staat de lijst met versies, nieuwste eerst, met bovenaan Nog niet uitgebracht — dat is werk dat al in het paneel zit maar nog niet onder een versienummer is gesneden.

Kies je een versie, dan zie je rechts wat erin zit:

• eerst alles wat actie vereist — dingen die je moet weten vóór je bijwerkt, met een rood label;
• daarna de wijzigingen gegroepeerd per soort: Toegevoegd, Gewijzigd, Gefixt, Verwijderd, Verouderd en Beveiliging;
• met een filter op soort en een zoekveld, als een release groot is.

Elke versie heeft een eigen adres, dus je kunt er rechtstreeks naar linken: /changelog/0.15.0. In de versielijst staat ook welke versie je op dit moment draait.

Voor beheerders: waar dit vandaan komt

De artikelen zijn markdown-bestanden in de repository, Nederlands en Engels naast elkaar, met een kopje bovenin dat zegt voor wie ze zijn en bij welk scherm ze horen:

ls docs/user/nl docs/user/en
head -9 docs/user/nl/een-server-toevoegen.md

---
id: adding-a-server
title: Een server toevoegen
audience: admin
section: platform
locale: nl
routeKey: /nodes/add
order: 10
---

routeKey is wat "Hulp bij deze pagina" gebruikt: het scherm /nodes/add opent dit artikel. Eén bron voedt alle drie de plekken — het paneel, het paneeltje bij een scherm, en de openbare site.

Het paneel leest die bestanden niet tijdens het draaien: ze worden in de build meegebakken. Na het bewerken van een artikel of een changelog-regel draai je dus de generatoren en commit je wat eruit komt:

cd corecp-panel/web
npm run gen:docs        # docs/user/**.md  → src/lib/docs*.gen.ts én de openbare site
npm run gen:changelog   # docs/changelog/  → src/lib/changelog.gen.ts

Vergeet je dat, dan wordt de build rood: scripts/ci.sh controleert of de gegenereerde bestanden nog gelijk zijn aan de documenten, én of een wijziging in de code een changelog-regel en een docs-update van hetzelfde gebied bij zich draagt.

De versie van het paneel staat op één plek en groeit mee met de changelog:

bash scripts/panel-version.sh show   # 0.16.0~dev4
bash scripts/panel-version.sh dev    # begin aan de volgende
bash scripts/panel-version.sh cut    # snijd hem, inclusief changelog-sectie

De volledige regels staan in docs/development.md en docs/panel.md.

Mist er iets?

Ontbrekende uitleg in de handleiding is een bug, geen omissie. Meld het bij je hostingpartij; ben je die zelf, dan is de kortste weg een artikel toevoegen in docs/user/nl/ en docs/user/en/ en de generator draaien.

Zie ook

• Aanmelden, wisselen en je weg vinden
• Installeren op je telefoon