Document360 hosten op een sub-directory

Plannen ter ondersteuning van het hosten van Document360 op een subdirectory

Wat is submap hosting?

Het hosten van submappen is een methode voor het organiseren en weergeven van inhoud op een website met behulp van mappen onder het hoofddomein (hoofddomein). Een submap (ook wel subdirectory genoemd) verschijnt na het hoofddomein in een URL en wordt gebruikt om de inhoud logisch te structureren.
Het hoofddomein van Document360 is document360.combijvoorbeeld . De URL van een submap/subdirectorypad kan dus .document360.com/docs/

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

Dit komt omdat 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).

NOTITIE

Hosting van submappen/submappen kan worden ingeschakeld voor door Document360 geleverde domeinen en in kaart gebrachte aangepaste domeinen.

Hosting van submappen inschakelen

Als u de hosting van submappen voor uw project wilt inschakelen,

1. Navigeer naar () in de linkernavigatiebalk in de Knowledge base portal.

2. Navigeer in het linkernavigatiedeelvenster naar Knowledge base site > Custom domain > Subfolder hosting tabblad.

   Het pad naar de submap is standaard ingesteld op /docs.

3. Schakel de wisselknop in naast 'Kennisbank wordt gehost als een submap'.
   Wanneer de schakelaar is ingeschakeld, is de openbare preview van artikelen zichtbaar. Dit voorkomt ook het invoegen van de workspace slug bij het invoegen van links in artikelen.

Aangepaste paden voor submappen

U kunt uw kennisbank ook instellen op andere paden van submappen/submappen dan /docs.

Bijvoorbeeld, /help, /support, enz.

1. Navigeer naar () in de linkernavigatiebalk van de Knowledge base portal.

2. Navigeer in het linkernavigatiedeelvenster naar Knowledge base site > Custom domain > Subfolder hosting tabblad.

   Het pad naar de submap is standaard ingesteld op /docs.

3. Wis het veld Pad submap en voer het pad van uw aangepaste submap in (bijvoorbeeld /help).

4. Klik op de Update knop aan de rechterkant.

   Deze nieuwe aangepaste submap werkt alleen als de instelling voor het hosten van submappen is ingeschakeld in uw project.

Wanneer u andere paden instelt, voegt u de talen toe die zijn gekoppeld aan elke werkruimte in uw project. Deze configuratie varieert afhankelijk van de verschillende webservers.

NOTITIE

Voor projecten die zijn geconfigureerd met aangepaste domein- en submaphosting, wordt de optie Voorvertoning van artikelen nog niet ondersteund.

API-paden voor aangepaste sites

Ter informatie (FYI)

De functie Aangepaste site-API-paden is alleen beschikbaar in KB-site 2.0-projecten. Als u wilt migreren van KB-site 1.0 naar KB-site 2.0, leest u het artikel op KB site 2.0 migration.

Het site-API-pad is standaard ingesteld op /api. U kunt het Site-API-pad ook aanpassen via het tabblad Submaphosting in de aangepaste domeininstellingen.

Bijvoorbeeld, /docs-api, /api-docs, enz.

VOORZICHTIGHEID

Voor KB-site 2.0-projecten werkt het hosten van submappen alleen als zowel het pad naar de submap als het pad van de site-API zijn gedefinieerd.

1. Navigeer naar () in de linkernavigatiebalk van de Knowledge base portal.

2. Navigeer in het linkernavigatiedeelvenster naar Knowledge base site > Custom domain > Subfolder hosting tabblad.

   Het site-API-pad is standaard ingesteld op /api.

3. Wis het veld Site-API-pad en voer het aangepaste site-API-pad in (bijvoorbeeld /docs-api).

4. Klik op de Update knop aan de rechterkant.

   Dit nieuwe API-pad voor aangepaste sites werkt alleen als de instelling voor het hosten van submappen is ingeschakeld in uw project.

NOTITIE

Het pad voor de aangepaste site-API is niet het pad voor API-documentatie.

Webservers

Hier zijn enkele van de veelgebruikte webservers

• Apache HTTP-server

• Nginx server

• ASP.NET Core-server

• Microsoft - IIS-server

• OpenResy-server

• LiteSpeed-server

• Cloudflare-server

NOTITIE

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

Wat gebeurt er nu?

Zodra de webserver met succes is geconfigureerd, is uw kennisbanksite live in uw aangepaste submap/subdirectory. De bestaande URL voor uw project zal echter aan de verzoeken voldoen.
Bijvoorbeeld, example.document360.io en example.com/docs (als /docs dit uw mappad is) verwijst naar de Knowledge Base-site.

Dit leidt tot dubbele inhoud in zoekmachines (Google, Bing, enz.). Hiervoor moet u een URL-omleiding inschakelen.

NOTITIE

Om de doorverwijzing van example.document360.io naar mogelijk example.com/docste maken, kunt u contact met ons opnemen via support@document360.com.

Probleemoplossing

URL toont nog steeds '/docs' ondanks dat het hosten van submappen is uitgeschakeld

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

Stappen om op te lossen:

Om het pad te veranderen,

1. Maak een nieuwe submap in uw project.

2. Schakel de instelling voor het hosten van submappen in voor de nieuw gemaakte submap.

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

404-fout als gevolg van dubbele '/docs' in canonieke URL

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

Stappen om op te lossen:

1. U kunt het probleem oplossen door de canonieke URL bij te werken zodat deze alleen het domein zonder het /docs pad bevat. 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.