Document360 hosten in een submap

Wat is subfolderhosting?

Subfolderhosting is de methode om inhoud op een website te organiseren en weer te geven met behulp van mappen onder het hoofd (root) domein. Een submap (ook wel submap genoemd) verschijnt na het worteldomein in een URL en wordt gebruikt om inhoud logisch te structureren.
Bijvoorbeeld, het root-domein van Document360 is document360.com. Dus, een submap/subdirectory pad-URL kan zijn document360.com/docs/.

De meeste bedrijven hosten hun documentatie onder een submap/subdirectory op hun websitedomein.
Bijvoorbeeld: example.com/docs, example.com/support, enzovoort.

Dit komt doordat het hosten van een kennisbank op een subdirectory/submap van een website (example.com/docs) in plaats van een subdomein (docs.example.com) beter is voor zoekmachineoptimalisatie (SEO).

OPMERKING

Subfolder/subdirectory hosting kan worden ingeschakeld voor door Document360 verstrekte domeinen en toegewezen aangepaste domeinen.

Subfolderhosting inschakelen

Om het hosting van de submap voor je project in te schakelen,

1. Navigeer naar () > Knowledge base site in de linker navigatiebalk in het Knowledge base portal.

2. Ga in het linker navigatiepaneel naar het tabblad Custom domain > Subfolder hosting .

   Standaard is het submappad ingesteld op /docs.

3. Zet de schakelaar aan naast "Kennisbank wordt gehost als submap."
   Wanneer de schakelaar wordt ingeschakeld, wordt de openbare preview van artikelen zichtbaar. Dit voorkomt ook het invoegen van de workspace slug bij het invoegen van links in artikelen.

Aangepaste submappaden

Je kunt je kennisbasis ook instellen op submappen/subdirectorypaden anders dan /docs.

Bijvoorbeeld, /help, /support, enzovoort.

1. Navigeer naar () > Knowledge base site in de linker navigatiebalk in het Knowledge base portal.

2. Ga in het linker navigatiepaneel naar het tabblad Custom domain > Subfolder hosting .

   Standaard is het submappad ingesteld op /docs.

3. Maak het pad van de submap leeg en voer je eigen submap pad in (bijvoorbeeld, /help).

4. Klik op de Update aan de rechterkant.

   Deze nieuwe aangepaste submap werkt alleen als de hostinginstelling van de submap in je project is ingeschakeld.

Voeg bij het instellen van andere paden de talen toe die aan elke werkruimte in je project zijn gekoppeld. Deze configuratie varieert afhankelijk van de verschillende webservers.

OPMERKING

Voor projecten die zijn geconfigureerd met aangepaste domein- en submaphosting wordt de optie voor Artikelvoorvertoning nog niet ondersteund.

Als je een aangepast Subfolderpad hebt gedefinieerd, vergeet dan niet je server te configureren om proxyverzoeken voor dit pad te doen. Je kunt de platformspecifieke serverartikelen raadplegen voor advies.

Aangepaste Site API-paden

Ter informatie (ter info)

De functie Custom Site API-paden is alleen beschikbaar in KB site 2.0-projecten. Om te migreren van KB-site 1.0 naar KB-site 2.0, lees het artikel over KB-site 2.0-migratie.

Standaard is het Site API-pad ingesteld op /api. Je kunt het Site API-pad ook aanpassen via het tabblad Submap hosting in de instellingen voor aangepaste domeinen.

Bijvoorbeeld, /docs-api, /api-docs, enzovoort.

Na het instellen van het Site API-pad moet je ook een overeenkomstige locatieblok op je webserver instellen (zoals /api, /docs-api, enz.).

Zorg ervoor dat de hier ingevoerde waarde exact overeenkomt met het pad dat is geconfigureerd in de reverse proxy-opstelling van je server.

Raadpleeg de relevante servergids voor configuratievoorbeelden:

• Nginx-server – Subfolderhosting

• ASP.NET Core-server

• Microsoft – IIS-server

• Apache HTTP server

VOORZICHTIGHEID

Voor KB site 2.0-projecten werkt subfolderhosting alleen wanneer zowel het Submappad als het Site API-pad zijn gedefinieerd.

1. Navigeer naar () > Knowledge base site in de linker navigatiebalk van het Knowledge base portal.

2. Ga in het linker navigatiepaneel naar het tabblad Custom domain > Subfolder hosting .

   Standaard is het Site API-pad ingesteld op /api.

3. Maak het veld voor het Site API-pad leeg en voer je aangepaste site API-pad in (bijvoorbeeld, /docs-api).

4. Klik op de Update aan de rechterkant.

   Dit nieuwe aangepaste site-API-pad werkt alleen als de submap hostinginstelling in je project is ingeschakeld.

OPMERKING

Het Custom Site API-pad is niet het pad voor API-documentatie.

Webservers

Hier zijn enkele van de meest gebruikte webservers

• Apache HTTP server

• Nginx-server

• ASP.NET Core-server

• Microsoft - IIS-server

• OpenResty-server

• LiteSpeed-server

• Cloudflare-server

OPMERKING

Wat is een webserver?
Een webserver slaat de inhoud van een website op en levert deze – zoals tekst, afbeeldingen, video en applicatiegegevens – aan clients die hierom vragen. Het meest voorkomende type client is een webbrowserprogramma.

Verplichte API-padopstelling voor KB-site 2.0

Als je KB 2.0 gebruikt en je kennisbank in een submap host, is het verplicht om een reverse proxy-configuratie toe te voegen voor het pad van je Site API (bijvoorbeeld /api) in je serverinstellingen.

Zonder deze configuratie kun je redirect-fouten of kapot API-gedrag tegenkomen.

Bezoek het relevante serverartikel voor installatie-instructies:

• Nginx-server – Subfolderhosting

• ASP.NET Core-server

• Microsoft – IIS-server

• Apache HTTP server

Wat gebeurt er nu?

Zodra de webserver succesvol is geconfigureerd, staat je kennisbanksite live in je aangepaste submap/subdirectory. De bestaande URL van je project zal echter de verzoeken bedienen.
Bijvoorbeeld, example.document360.io en example.com/docs (als /docs het je mappad is) zal wijzen op de Knowledge Base-site.

Dit veroorzaakt dubbele inhoud in zoekmachines (Google, Bing, enz.). Om dit te doen, moet je een URL-redirect inschakelen.

OPMERKING

Om de doorverwijzing van example.document360.io naar example.com/docsmogelijk te maken, kunt u contact met ons opnemen op support@document360.com.

Probleemoplossing

De URL toont nog steeds '/docs' ondanks dat submaphosting is uitgeschakeld

Standaard wordt de documentatie gehost onder de /docs submap, en dit pad blijft zichtbaar in de URL, ongeacht of de hosting van de submap is geactiveerd of gedeactiveerd.

Stappen om op te lossen:

Om het pad te veranderen,

1. Maak een nieuwe submap aan in je project.

2. Schakel de hostinginstelling voor de submap in voor de nieuw aangemaakte submap.

3. Voltooi de vereiste configuratie om het aangepaste URL-pad toe te passen.

404-fout door gedupliceerde '/docs' in de canonieke URL

Wanneer je site onder een /docs submap wordt gehost, zorgt het toevoegen /docs van de canonieke URL ervoor dat deze twee keer verschijnt in de uiteindelijke URL (bijvoorbeeld artikelnaam/docs/docs/), wat leidt tot een 404-fout.

Stappen om op te lossen:

1. Om het probleem op te lossen, werk je de canonieke URL bij zodat alleen het domein zonder het pad wordt /docs opgenomen. Stel bijvoorbeeld de canonieke URL in als: https://yourdomain.com/article-name

2. Dit zorgt ervoor dat de /docs submap slechts één keer wordt toegevoegd, waardoor de juiste URL-structuur behouden blijft en 404-fouten worden voorkomen.