Een documentatiesite importeren en exporteren

Verplaats je bestaande helpcenter naar een Clevera-documentatiesite, of download alles van een site als een zipbestand. Imports nemen pagina's, afbeeldingen, structuur, vertalingen en oude adressen mee; exports geven je de inhoud als HTML- of Markdown-bestanden. Beide zijn gratis.

Voordat je begint#

• Open je documentatiesite en ga naar Instellingen → Import & export.
• Alleen de eigenaar van de workspace kan importeren of exporteren. Beheerders kunnen het tabblad openen en rondkijken, maar de bedieningselementen zijn uitgeschakeld: "Alleen de eigenaar van de workspace kan inhoud importeren of exporteren."
• Importeren en exporteren kost geen credits, op elk abonnement.
• Geïmporteerde pagina's zijn pas live nadat je ze publiceert, dus je kunt ze eerst controleren.

Je documentatie importeren#

1. Kies je platform#

   Klik onder Inhoud importeren op het platform waar je documentatie staat. Als het er niet bij staat, kies dan Elke andere documentatiesite.

   

2. Verbinding maken#

   Kies hoe je verbinding wilt maken onder Hoe verbinding maken, vul de velden in en klik op Verbinding controleren. Zie Platforms en methoden voor wat er per platform wordt gevraagd.

3. Voorbeeld#

   Clevera toont de secties en pagina's die het heeft gevonden. Vink pagina's uit die je niet wilt. Een grote site kan even duren: "We zijn alle secties en pagina's aan het ophalen."

4. Kies de opties#

   Kies waar de pagina's naartoe gaan en welke talen je wilt meenemen. Zie Importopties.

5. Bevestigen en starten#

   Controleer de samenvatting, bijvoorbeeld "We kopiëren 120 pagina's naar een nieuwe sectie, “Helpcenter”." en de Geschatte tijd, en klik vervolgens op Import starten.

Je kunt het venster sluiten terwijl het proces loopt: "Je kunt dit venster sluiten. We sturen je een e-mail wanneer de import is voltooid." De voortgang toont Pagina's importeren, Afbeeldingen kopiëren, Pagina's koppelen en Omleidingen toevoegen, met aantallen voor Pagina's, Afbeeldingen en Mislukt.

Wanneer het klaar is, ontvang je een e-mail, "Je import van platform is gereed", met Het rapport bekijken. Controleer daarna de pagina's en publiceer de site.

Platforms en methoden#

Elke platformkaart toont de ondersteunde methoden: API, Openbare site en Repository / zip.

De methoden#

Openbare site. Plak het adres van je openbare documentatie (de startpagina of een willekeurige documentatiepagina) onder Site-adres. Clevera leest de pagina's die in de navigatie of sitemap staan, in een rustig tempo dat je robots.txt respecteert. Alleen pagina's onder dat adres worden gelezen. Privéartikelen en concepten worden niet meegenomen.

API-token of -sleutel. Plak een token dat je op het andere platform hebt aangemaakt. Elke platformkaart bevat de stappen en een link naar de plek waar je dit aanmaakt. Clevera leest alleen. Tokens worden gebruikt tijdens de import en binnen 24 uur verwijderd. Je kunt het token op het andere platform intrekken zodra de import is voltooid.

Git-repository. Plak het Repository-adres (GitHub, GitLab of Bitbucket). Voeg voor een privé GitHub-repository een Toegangstoken toe met alleen-lezen toegang tot de inhoud (Contents). Clevera downloadt de standaard branch als archief en voert de code nooit uit.

Een zipbestand uploaden. Upload een .zip van je documentatie, tot 200 MB. Clevera leest Markdown, MDX, JSON, YAML en afbeeldingen en negeert al het andere. Voor Elke andere documentatiesite kan de zip .md, .mdx of .html bestanden bevatten, en elke map op het hoogste niveau wordt een sectie.

Platformopmerkingen#

• Intercom staat niet toe dat toegangstokens worden gedeeld met andere apps, dus Clevera leest je openbare helpcenter.
• Zendesk API-toegang vereist een beheerder op een abonnement vanaf Team. Elke agent leest gepubliceerde artikelen; een Guide-beheerder neemt ook concepten en beperkte artikelen mee.
• Help Scout laat je kiezen tussen Alleen gepubliceerde artikelen of Gepubliceerde artikelen en concepten. De API-sleutels kunnen niet alleen-lezen zijn, dus verwijder de sleutel achteraf.
• ReadMe API-referentiepagina's, recepten en aangepaste pagina's blijven op ReadMe staan.
• Document360 API-toegang is beschikbaar op de Business- en Enterprise-abonnementen en vereist een nieuwere API-sleutel.
• Notion vereist dat de eigenaar van de workspace de verbinding maakt, met "Alleen inhoud lezen".
• Confluence werkt met Confluence Cloud-sites.
• Documentatie met meerdere versies: alleen de nieuwste versie wordt geïmporteerd.

Importopties#

Voor de methode Openbare site vink je ook "Ik ben de eigenaar van deze inhoud of heb het recht om deze te kopiëren." aan voordat je begint.

Hoe de structuur wordt overgenomen#

• Pagina's, afbeeldingen, secties, groepen, vertalingen, omleidingen en changelog-items worden geïmporteerd.
• Documentatiesites hebben secties met één niveau aan groepen eronder. Diepere niveaus worden één niveau omhoog verplaatst, met een waarschuwing in het rapport.
• Geïmporteerde pagina's zijn klaar om te publiceren; ze gaan live bij je volgende publicatie. Geïmporteerde changelog-items komen binnen als concepten.
• Afbeeldingen worden naar de site gekopieerd. Een afbeelding die niet kan worden gekopieerd, wordt overgeslagen met een waarschuwing, en de alt-tekst blijft behouden.
• Links tussen geïmporteerde pagina's worden naar hun nieuwe adressen verwezen. Links naar pagina's die niet zijn geïmporteerd, behouden hun oorspronkelijke adressen.
• Pagina's die alleen in de sitemap staan, en niet in het menu, worden in een groep genaamd "Meer pagina's" geplaatst.

Limieten#

De kaart toont hoeveel imports je vandaag nog over hebt en de paginalimiet.

Het importrapport#

Klik op Rapport bekijken onder Recente imports. Het rapport toont de sectie en totalen voor Geïmporteerd, Overgeslagen, Mislukt, Afbeeldingen en Omleidingen. Filter de pagina's op Mislukt, Met waarschuwingen of Overgeslagen, en klik op Openen in editor om er een te herstellen.

Voorbeelden van waarschuwingen:

• "Deze pagina was dieper genest dan documentatiesites toestaan, dus is deze een niveau omhoog verplaatst."
• "Een afbeelding kon niet worden gekopieerd, dus is deze weggelaten"
• "Een pagina met dit adres bestaat hier al, dus is deze overgeslagen."
• "Overgeslagen: robots.txt of de adresregels van de site verhinderen ons om deze pagina te lezen."

Een import ongedaan maken of annuleren#

• Import annuleren stopt na de pagina's die op dat moment worden gelezen. Reeds geïmporteerde pagina's blijven staan en je kunt ze ongedaan maken vanuit het rapport.
• Import ongedaan maken verwijdert de pagina's, afbeeldingen, omleidingen en changelog-items die de import heeft aangemaakt, evenals de nieuwe sectie als deze nu leeg is.

Een site exporteren#

1. Kies een formaat#

   Kies onder Je gegevens exporteren het Exportformaat: HTML (pagina's die je in een browser opent, afbeeldingen in een eigen map) of Markdown (platte .md bestanden, afbeeldingen in een eigen map).

   

2. Aanvragen#

   Klik op Export aanvragen. Je ziet "Export aangevraagd. We sturen een downloadlink naar" je adres, "meestal binnen 10 minuten".

3. Downloaden#

   Open de e-mail "Je export van site is klaar" en klik op Export downloaden. Je moet ingelogd zijn bij Clevera. De link werkt 7 dagen; de export is ook zichtbaar onder de kaart met Downloaden totdat deze verloopt.

Het zip-bestand bevat:

• Elke pagina op de site, inclusief concepten gemarkeerd als "Draft", in elke taal, ook sitepagina's.
• De changelog, inclusief concepten.
• Afbeeldingen, elk één keer opgeslagen.
• De navigatie, site-instellingen, redirects (redirects.csv) en een lijst met video's (videos.csv), met een README.txt die de bestanden uitlegt.

Je kunt 3 exports per site per dag aanvragen (een voortschrijdende 24 uur). Een mislukte export telt niet mee. Alleen de persoon die een export heeft aangevraagd, kan deze downloaden. Wanneer de eigenaar exporteert, krijgen beheerders een melding dat er een export is gemaakt.

Video's#

Video's zitten niet in het zip-bestand. In de bestanden is elke video een link: "Bekijk / exporteer deze video". De Video's-kaart toont elke Clevera-video op de pagina's van de site met Video exporteren, waarmee de video wordt geopend zodat je deze in de gewenste kwaliteit kunt exporteren.

Probleemoplossing#

Gerelateerd#