Dokumentationspanelen

Bokikonen i sidhuvudet öppnar plattformens dokumentation i en panel till höger. Sidan du arbetade på syns fortfarande bredvid — den smalnar av i stället för att täckas över — och panelen är kvar medan du rör dig i portalen. Dra i panelens vänsterkant för att göra den bredare eller smalare; portalen kommer ihåg bredden åt dig i den här webbläsaren. På en smal skärm, som en mobil, fyller panelen hela skärmen. Esc stänger den.

Panelen visar dokumentationen för allt som är installerat på plattformen, på portalens språk: bläddra i innehållsförteckningen, eller sök efter ett ämne i sökfältet i sidhuvudet — dokumentationsträffar visas under Dokumentation. En sida som beskriver något du saknar behörighet för i den aktuella boundaryn säger det ("Kräver … — det har du inte här"); du kan ändå läsa den.

Öppna i eget fönster flyttar dokumentationen till ett separat webbläsarfönster; medan det fönstret är öppet öppnas dokumentation du öppnar från portalen — till exempel en sökträff — där. Plattformar som är äldre än dokumentationstjänsten visar i stället Dokumentationen är inte tillgänglig.

Felmeddelanden leder också hit. När portalen visar ett fel som dokumentationen förklarar — i en avisering eller på sidan — har det knappen Läs mer, som öppnar panelen vid förklaringen. Inifrån en dialogruta, eller medan en är öppen, öppnas dokumentationen i stället i ett eget fönster, eftersom panelen skulle hamna bakom dialogrutan.

Panelen

Del	Vad den gör
Bokikonen, i sidhuvudet	Öppnar panelen, eller stänger den om den är öppen
Användare och Administratörer	Växlar mellan guiderna för dem som använder plattformen och dokumentationen för plattformens operatörer. Visas bara för plattformsadministratörer (lifecycle/view i plattformens rot); alla andra ser användarguiderna.
Öppna i eget fönster	Se Ett eget fönster
Stäng	Stänger panelen. Esc gör detsamma när du är i panelen, utom i ett filterfält med text: där rensar det först filtret.
Vänsterkanten	Dra i den för att ändra panelens bredd, eller markera den och använd vänster- och högerpilarna; Home och End gör panelen så smal eller så bred som det går. Panelen är minst 320 pixlar bred och tar högst 60 % av fönstret, upp till 960 pixlar.

Läsa en sida

• Panelen öppnas på innehållsförteckningen: ett avsnitt per installerad modul, med modulens ikon, namn och antal sidor. När du väljer en sida ersätter den innehållsförteckningen; sökvägen ovanför sidans rubrik — som börjar med All dokumentation — leder tillbaka.
• Per modul och Per typ, ovanför innehållsförteckningen, växlar mellan den vyn och en som är grupperad efter typ av sida: Handledningar för att lära dig genom att göra, Instruktioner för en uppgift, Referens för att slå upp något och Förklaringar för hur saker fungerar. Valet står kvar medan du läser en sida och kommer tillbaka.
• Välj rubriken för en modul eller en typ för att fälla ihop dess sidor, och välj den igen för att visa dem. Allt är utfällt från början; portalen kommer ihåg vad du har fällt ihop i den här webbläsaren.
• Filtrera sidor, överst i innehållsförteckningen, smalnar av den medan du skriver: till sidor vars titel, modul eller beskrivning innehåller det du skrev, oavsett versaler eller accenter ("atkomst" hittar "Åtkomst"). Den del av varje titel som matchar är markerad, moduler med träffar fälls ut och resten döljs tills du rensar filtret. Esc i fältet rensar det; ett andra Esc stänger panelen. När inget matchar står det Inga sidor matchar, med Rensa filtret under. Filtret och växlaren ligger kvar överst medan innehållsförteckningen rullar.
• Under Referens kommer varje moduls handskrivna sidor först; referensen som genereras från själva plattformen — API-, konfigurations- och IAM-referens — följer under API- och konfigurationsreferens.
• Adresser och namn i texten är ifyllda för din installation.
• Maskinöversatt markerar en sida som ingen person har granskat än.
• Kräver … — det har du inte här listar de behörigheter som sidans steg kräver och som du inte har i den boundary som är vald i sidomenyn. Det är en upplysning, inte ett lås.
• En länk till en modul som inte är installerad på plattformen visas som text, markerad "inte installerad på den här plattformen".
• Kodexempel har knappen Kopiera kod.

Ett eget fönster

Öppna i eget fönster stänger panelen och öppnar dokumentationen som en egen sida, på https://portal.example.com/docs, i ett separat webbläsarfönster eller en separat flik, med innehållsförteckningen bredvid sidan. Medan det fönstret är öppet öppnas dokumentation som du öppnar någon annanstans i portalen — till exempel en dokumentationsträff i sökningen — där i stället för i panelen. Bokikonen öppnar fortfarande panelen.

Hjälpte det här?

Varje sida slutar med Hjälpte det här? Svara Ja eller Nej; svaret sparas direkt, och du kan lägga till en kort kommentar. Ett nytt svar ersätter ditt tidigare. Sökningar i dokumentationen som du skickar med Enter och som inte hittar något alls, ingen sida, resurs eller dokumentation, räknas också; träffar som visas medan du skriver räknas inte. Båda stannar på den här plattformen och sparas utan ditt namn; en administratör kan exportera dem och skicka dem till Stackship, så skriv inga personuppgifter i en kommentar. Se Återkoppling på dokumentationen för vad som sparas.

När dokumentationen inte kan visas

• På en plattformsversion utan dokumentationstjänsten visar panelen Dokumentationen är inte tillgänglig — "Dokumentationen finns inte i den här plattformsversionen."
• Om dokumentationen inte kan läsas in försöker Försök igen på nytt.