← Všechny dokumenty
Průvodce terénem Portal Studio

Vybudovat odvážně, dobře publikovat.

Jeden praktický odkaz pro správce, kteří formují zkušenosti zákazníků a vývojáře, kteří jej rozšiřují. Dokumentuje skutečnou Studio architekturu, řízenou cestu uvolnění, vlastnická funkce, identity, migrace, smlouvy o součástkách a obnovu.

Portálový dokument v2Správce + vývojářPracovní postup uvolňování podnikůAktualizováno 1 Srpen 2026
Správce průvodce · Architektura

Víš, co Studio vlastní

Portal Studio vlastní mušle, která je určena pro zákazníky: stránky, umístění komponentů, značkové žetony, citlivé chování, navigace, footer, prezentace identity, letenky a výjezdy. Centrum nápovědy vlastní jazyky, kategorie, sekce a obsah článku. Studio spotřebovává tento obsah přes chráněný most; nikdy nevytváří druhý obchod s články.

Nápověda Center + vstupenky + služby identityAdaptéry pro bezpečné použitíPortálový dokument v2 návrhJeden kompilátor a zvěstovatelNáhled a publikované Portál
Pravidlo o jednoznačném zvěstování: Náhled a veřejné stránky používají stejnou smlouvu o dokumentu / kompilátoru. Publikace se nikdy nepřepne na nesouvisející šablonu.
Portálový ateliér · Mapa pracovního prostoru
Živé plátnoDesktop · Zákazník
Portál zákazníkůStejný strukturovaný dokument používaný v náhledu a veřejné vykreslování
Mapa rozhraní: pracovní dráha, živé plátno a inspektor se zaměřují na stejný stabilní výběr stránek a uzlů.
Správce · Start

Kompletní připravenost před hlubokým budováním

  1. Otevřít Portálový ateliér → Začít → Reakční.
  2. Potvrďte kanonickou adresu portálu a otevřete ji v samostatném záložce.
  3. Nastavte logo, ikonu prohlížeče, dotykovou ikonu, sociální image a barvu motivu.
  4. Potvrďte Jazyky centra nápovědy; změňte jazykovou autoritu v centru nápovědy, ne Studio.
  5. Nastavit navigaci a globální podnik footer.
  6. Vyberte si cestu a nastavte alespoň jeden formulář žádosti.
  7. Uchovejte alespoň jeden bezpečný indikátor v metodě aktivní a zhodnotit objevení identity.
  8. Spustit kvalitu a vytvořit podepsaný náhled podání ruky.
  9. Vytvořit první regulované vydání po každém blokování položky je jasné.

Procento připravenosti se počítá ze uložených dat pracovního prostoru a stavu náhledu. Výběr položek přímo do jeho vlastnického panelu.

Správce · Build

Vybudovat stránky a opakovaně použitelné sekce

  1. Otevřít Vybudovat → Stránky a vyberte chráněnou systémovou stránku nebo vytvořte vlastní stránku.
  2. Nastavte trasu, název, přístupový režim a místní chování. Chráněné systémové trasy nelze smazat.
  3. Otevřít Součásti, filtrovat podle práce nebo splatnosti a umístit složku do kompatibilní slot.
  4. Pro obsah, vzhled, vazbu, viditelnost a dostupnost použijte inspektora.
  5. Používejte opakovaně použitelné vzory pro opakované struktury; udržujte organizaci nebo rozdíly značky ve variantách.
  6. Uložit návrh a cvičení zatížení, prázdné, chyba, host a znaménko -ve stavu v náhledu.
Knihovna komponent · Sanitizovaná mapa rozhraní
Hledání znalostíGA · zákaznický trezorKategorieGA · PomůckyČlánekGA · přeloženo DTOFormulář žádostiGA · verzeČasová osa tipuBeta · varováníDatový grafPlánované · bloky publikovat
Mapa rozhraní: před umístěním jsou viditelné kategorie, kompatibilita a zralost. Plánované blokové vydání komponent; beta komponenty vyžadují explicitní zpracování.
Správce · Značka a reagující

Prohlédněte si skutečné cesty, ne jednu šťastnou obrazovku

  1. Vyberte si podporu hosta, znakovou jízdenku, fakturační péči, organizaci nebo předávání znalostí.
  2. Přepnout personas, organizace, role a Nápověda Center jazyk.
  3. Prohlédněte mobilní, velké mobilní, tablety, notebook, stolní počítače, široké a ultraširoké body.
  4. Zkontrolujte zděděné, převrácené a resetované hodnoty; vyhněte se zbytečnému duplikaci zlomu.
  5. Spustit klávesnici, RTL, reduced- motion, načítání, prázdné, nedostupný a povolení stavy.
  6. Před přezkoumáním použijte zkušební laboratoř pro dostupnost, užitečné zatížení, trasu, vazbu a výsledky.
Zelené plátno není rozhodnutí o propuštění. Governed pre flight, review stav, schopnosti a uvolnění důkazy rozhodnout, zda Portál může zveřejnit.
Správce · Zkušenosti

Provozujte centrum nápovědy Zendesk- level bez duplikátu

  1. Vytvořit kategorie, sekce, články, překlady, přílohy a šablony v Centrum nápovědy.
  2. Povolit jazyky tam; lokalizované kulky, vyhledávání, kanály, SEO a článek chrom sledovat stejný orgán.
  3. Ve Studiu, umístit vyhledávání znalostí, kategorie / zdroje mřížky, kanály, téma akordeon, článek, tabulka obsahu, zpětná vazba, související a předchozí / další komponenty.
  4. Nastavit zobrazené, populární a nejnovější kanály; použít kontextové návrhy v proudech tipu.
  5. Náhled na žádné výsledky, dlouhé články, přílohy, zpětná vazba, hodinky / předplatné a předání vstupenek.
  6. Po zveřejnění ověřte čisté locale trasy, kanonický / heflang, strukturované údaje a cache neplatnost.
Hranice orgánu: editovat obsah článku a zákaznické jazyky v centru nápovědy. Použijte Portálové studio pouze pro sestavení, jak jsou objeveny a zobrazeny znalosti.
Správce · Identita a organizace

Nastavit signál bezpečně

  1. Otevřít Identita & organizace → Identity a udržet alespoň jeden signál v cestě zapnutý.
  2. Vyberte výchozí metodu, registrační pravidla, dobu trvání sezení, SSO-Dominální prosazování a objevování chování.
  3. Přidat poskytovatele s vizuálním směrovacím polem: typ, domény, priorita, prezentace, zapnutý a ověřený stav. Tajemství zůstávají v subsystému identity.
  4. Pro SCIM, zapněte zásobování, kopírujte přesný koncový bod pracovní plochy a otočte token. Uložte jednočasový token v IDP.
  5. Mapové nároky a členství v organizaci, poté test vytvořit, aktualizovat, skupinové členství a deaktivace s testovacím nájemníkem.
  6. Náhled host, zákazník, delegovaná organizace a blokované stavy před zveřejněním.
Nikdy neposílejte cookie Studio relace na SCIM. Je to bezsesionless, pracovní prostor-vázána nosič API. Otočit token po náhodném vystavení.
Správce · Cestování jízdenkou

Sestavit kompletní podpůrnou cestu

  1. Vyberte přímý formulář, průvodce, search- first, hub nebo service- desk vstup.
  2. Vytvořte si pojmenovaný formulář s žádostí o verzi s oddíly a přístupnými polem.
  3. Vybudovat vizuální podmínky, směrování, SLA a schvalovací kroky; pokročilé JSON je pouze pro revidované změny vývojáře.
  4. Nastavit seznam, detail, vlákno, časová osa, připojení, schválení, SLA a odpovědět povrchy.
  5. Test host vyhledávání, signed- in požadavky, viditelnost organizace, nahrávání selhání, e-mailové oznámení a znalosti deflekci.
  6. Uložit návrh; zveřejnit pouze po přeletu traťového adaptéru a notifikační cesty.
Správce · Přezkum a vydání

Přesunout přes regulované uvolnění

Návrh uloženV rámci přezkumuSchválenoPlánované nebo zveřejněnéPozorované nebo převrácené
  1. Spustit validaci a zkušební laboratoř. Opravit blokování zjištění; potvrdit povolená varování s kontextem.
  2. Přidat poznámky k vydání a žádost o přezkoumání. Recenze komentář na stabilní stránky / uzel cesty.
  3. Příchozí kontrolují rozdíly, ukázkové cesty, změny povolení a důkazy.
  4. Publikovat nebo rozpis přes pracovník pozadí. Opuštění Studio nezruší trvalou práci.
  5. Sledujte pokrok, zdravotní a korelační ID. Stop / retry pouze z kontroly práce.
  6. Ověřte kritické trasy, identitu, jízdenky a znalosti. Přejeďte zpět na neměnné předchozí vydání, pokud je to nutné.
SchopnostÚčel
Zobrazit / UpravitProhlédněte nebo změňte návrhy bez povolení k uvolnění.
Přezkum / schváleníOddělená zpětná vazba a schválení od autorů.
Harmonogram / publikovat / RollbackNezávislé kontroly výroby.
Identita / SCIM / Migrate / Components / DiagnosticsOmezte citlivé specializované operace.
Správce · Migrace a prodloužení

Migrovat s důkazy a cestou zpět

  1. Vyberte plán poskytovatele a vytvořte suchý běh.
  2. Recenze objevených nastavení, nemapovaných hodnot, počtu obsahu a vizuálních paritních zachycení.
  3. Kompletní bezpečné mapování a přesměrování strukturovaného rozdílu.
  4. Aplikujte na návrh, sladit počty a náhled každé chráněné cesty.
  5. Zaznamenejte autorizované přijetí; nikdy nepřepište aktuální zveřejněné vydání během dovozu.
  6. Publikovat prostřednictvím správy a udržet zprávu o migraci, uvolnění ID a převrácení bod dohromady.
Průvodce rozšiřováním vývojářů · Architektura

Rozšiřují se smlouvy, nikoli šablony

Bezpečné rozšíření registruje stabilní typ a schéma komponent, prohlašuje povolení a potřeby dat, propouští kanonický kompilátor, a dodává deterministické přípravky / testy. Nedotazovat libovolné tabulky, vstřikovat editor JavaScript do veřejného portálu, vytvořit jiný článek úložiště, nebo obejít uvolňovací bránu.

Portálový dokument v2

Stránky obsahují stabilní uzly, sloty, vlastnosti, vazby, responsibilní přejetí, podmínky a metadata přístupnosti.

Registr součástí

Jedna smlouva obsahuje Studio, kompilátor, dokumentace, migrace a kontroly zralosti.

Registr zdrojů dat

Přípustné, pouze pro čtení, povolení-oskenované DTOs nahrazují svévolné SQL nebo dynamické akce.

Jeden posel

Náhled a veřejná tvorba akcií, sanace, rozpočty a runtime států.

Vývojář · Smlouva o komponentě

Definovat balíček komponentů

Použijte malý jmenný prostor ID a sémantické verze. Dodávejte jak názvy vlastností kompatibility, které jsou uvedeny, protože kontrola balíku a validace bezpečnosti provádějí nezávislé kontroly.

{
  "schema_version": 1,
  "id": "acme.support_health",
  "slug": "acme-support-health",
  "name": "Support health",
  "version": "1.0.0",
  "entry": "renderer.php",
  "renderer": "server",
  "server_renderer": "renderer.php",
  "public_renderer": "public.js",
  "schema": {
    "type": "object",
    "properties": {
      "heading": {"type": "string", "maxLength": 120},
      "showSla": {"type": "boolean", "default": true}
    },
    "additionalProperties": false
  },
  "permissions": ["tickets.read"],
  "data_scopes": ["tickets.mine"],
  "accessibility": {
    "landmark": "section",
    "nameFrom": "heading",
    "emptyState": true,
    "errorState": true
  },
  "performance": {"max_js_bytes": 12000, "max_css_bytes": 8000},
  "performance_budget": {"js": 12000, "css": 8000, "requests": 0}
}

Tvar uzlu

{
  "id": "node-support-health",
  "type": "custom.acme_support_health",
  "props": {"heading": "Support health", "showSla": true},
  "bindings": {"requests": {"source": "tickets.mine", "limit": 5}},
  "responsive": {"mobile": {"padding": "16px"}, "desktop": {"padding": "24px"}},
  "conditions": [{"field": "identity.signed_in", "operator": "equals", "value": true}],
  "a11y": {"label": "Support health"}
}
  • Průkazy jsou stabilní v celém rozsahu úprav a migrace.
  • Vlastnosti odmítají nehlášená pole a nebezpečné HTML.
  • Každý pohled vázaný na data definuje výstup načítání, prázdno, oprávnění a chyby.
  • Kontejnerové komponenty pojmenují své sloty; listy nemohou přijmout svévolné děti.
  • Mark Scetence upřímně: plánované bloky, beta varuje, GA vyžaduje plné důkazy.
Vývojář · Zdroje dat a vazby

Používejte povolení-bezpečné DTOs

  1. Vyberte stávající tečkované ID, jako je tickets.mine, knowledge.featured nebo customer.profile.
  2. Vazba pouze pole deklarovaná jeho verzí DTO. Neznámé zdroje selhávají data_source.unknown.
  3. Projděte autorizovaným Portálem; nikdy nepřijímejte pracovní prostor / zákaznickou identitu z nedůvěryhodné vlastnosti.
  4. Mezní hodnoty seznamu jsou uchyceny1–100 Normalizace pohanění, lokalizace a vyhledávací hodnoty.
  5. Pokud je nový zdroj nevyhnutelný, přidejte jeho stabilní definici, bezpečné mapování, oprávnění, prázdné chování a náhled fixture společně.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Zdroje dat jsou pouze read-. Mutace vyžadují výslovnou autorizovanou službu akce, pracovní prostor vázání, CSRF / zasedání nebo potvrzení nositele, idempotency v případě potřeby a zadané chybové obálky.
Vývojář · Bezpečnost

Zůstaň uvnitř hranic důvěry.

HranicePožadované chování
Pracovní prostorVyřešte z důvěryhodného hostitele / trasa / relace, pak proveďte každé čtení a zapište před provedením.
HTMLPoužívejte Portal Sanitizer / Parser allowlist. Nikdy konkatetovat nedůvěryhodné atributy, URLs, CSS nebo scénář.
NáhledVyžadovat stejné zdrojové okno, podepsanou verzi kanálu a non. ignorujte nevyžádané zprávy.
IdentitaUdržet tajemství mimo dokumenty. SCIM je nositelem-ověřené, sessionless a pracovní prostor-vázána.
BaleníZamítněte průchod, absolutní cesty, odkazy / speciální soubory, nadrozměrné archivy, kontrolní součet / podpis nesoulad a neznámá oprávnění.
ChybyVrátit stabilní kód, bezpečné zprávy, retryable, sanace a korelace ID; log soukromé výjimky serverside.
ZnalostiPřečtěte si přes HelpCenterBridge. Nikdy autor nebo duplikát Help Center články v prodloužení.
{
  "success": false,
  "error": {
    "code": "studio.permission_denied",
    "message": "You do not have permission to publish the Portal.",
    "retryable": false,
    "correlation_id": "ps_…",
    "meta": {"capability": "publish"}
  }
}
Vývojář · Balíček a migrace

Prohlédněte, nainstalujte a upgradujte atomicky

  1. Put component.json u kořene ZIP a udržujte každou cestu relativní.
  2. Proveďte inspekci jako první. Instalátor uzamkne archivy na 500 záznamy a 25 MB extrahováno; validace bezpečnosti přidává nezávislé limity.
  3. Ověřte očekávaný SHA-256 a podpis balíčku v procesu uvolnění.
  4. Nainstalujte do adresáře s verzí. Nikdy nezmutujte nainstalovanou verzi na místě.
  5. Poskytněte immigraci majetku pro prolomení změn schématu a zachovat neznámé pole kompatibility.
  6. Otevřete složku v návrhu, spusťte každý stát / viewport / persona fixture a zveřejněte prostřednictvím správy.
  7. Převrácení aktivuje předchozí shodné vydání součásti / dokumentu; ponechá si důkazy o reprodukovatelnosti.
Vývojář · Testy a uvolnění

Prokázat rozšíření na stejné vydání hash

php tools/portal_studio_certify.php --source-only --json
php tools/test_portal_studio_contract.php
php tools/test_portal_one_renderer.php
php tools/test_portal_studio_engineer.php
php tools/test_portal_component_contracts.php
php tools/test_portal_one_renderer.php
php tools/test_portal_shell_contract.php
php tools/test_portal_knowledge_contract.php
node node_modules/@playwright/test/cli.js test tests/e2e/portal-studio-shell-visual-contract.spec.js tests/e2e/portal-custom-code-runtime.spec.js

Zdrojové brány jsou nezbytné, nestačí. Připojte databázi / migraci, real-browser vizuální, identifity-provider, autorizace- izolace, dostupnost, výkon, fronta / cron, mail / příloha, zálohování / obnovení a nasazení důkazů ke stejnému neměnnému uvolnitelného hash. Neznámý požadovaný důkaz musí být vyřazen.

  • Jednotka: schéma, dezinfekce, tvar DTO, podmínky, migrace a selhání na stroji.
  • Smlouva: nakládka / prázdné / chyba / úspěch, splatnost, sloty, vazby a jednosměrná parita.
  • Prohlížeč: klávesnice, ostření, sémantika, RTL, zoom / reflow, snížený pohyb a každý bod zlomu.
  • Bezpečnost: sondy pro mezipracovní prostory, padělání akcí, útoky balíčků, ukázka podfuku a tajného úniku.
  • Operace: trvalý pokrok, dovolená / návrat, stop / retry / return, srdeční tep a zpětný chod.
Správce + vývojář · Recovery

Potíže podle stavu a korelace ID

StátCo dělat
PovoleníPožadujte pojmenované schopnosti. Skryté UI je pohodlí; backend vždy podporuje.
OvěřeníOtevřete stránku / uzel / pole, opravte to, pak znovu zadejte předlet.
KonfliktObnovit nejnovější revizi, porovnat změny a použít záměrně. Nikdy vynutit přepsat.
Offline / opakovatelnéUdržujte návrh, obnovte konektivitu, znovu se pokuste prostřednictvím akce a ověřte trvalý stav práce.
Smrtelné / nedostupnéKopírovat korelaci ID a časový razítko pro podporu. Nikdy vložte tajemství nebo soukromý text výjimky.
Publikovat selhaloZkontrolujte výstup před letem / zaměstnání, zkuste pouze retestovatelné fáze, nebo se vraťte zpět do posledního zdravého vydání.
SCIM 401/403Potvrdit koncový / pracovní prostor, znamení nositele, stav a rotaci; nikdy nepoužívejte prohlížeč session cookie.
Znalosti jsou zatuchlé.Ověřte lokalizaci / publikaci v Pomocném centru, pak zkontrolujte zrušení cache a čistou lokalizovanou trasu.

Tento návod je print- ready. Použijte Print → Uložit jako PDF pro řízenou offline kopii.