← Všetky dokumenty
Portál Studio sprievodca

Budujte odvážne.

Jedným z praktických odkazov pre správcov, ktorí formujú skúsenosti zákazníkov a vývojárov, ktorí ju rozširujú. Dokumentuje skutočnú architektúru Studio, riadenú cestu vydania, vlastníctvo Help centra, identitu, migráciu, zmluvy o komponentoch a obnovu.

Portál v2Administrátor + vývojárFungovanie podnikového uvoľňovaniaAktualizované 1 August 2026
Sprievodca administrátor · Architektúra

Vedieť, čo Studio vlastní

Portal Studio vlastní shell orientovaný na zákazníka: stránky, umiestnenie komponentov, značky žetóny, responzívne správanie, navigáciu, päta, prezentácia identity, cesty a vydania vstupeniek. Centrum pomoci má jazyky, kategórie, sekcie a obsah článku. Štúdio spotrebuje tento obsah prostredníctvom chráneného mosta; nikdy nevytvára druhý obchod s článkami.

Centrum pomoci + vstupenka + služby identityDátové adaptéry bezpečné pre povoleniePortál dokument v2 návrhJeden kompilátor a kresbaNáhľad a publikovaný portál
Pravidlo pre jedného účastníka: Preview a verejné stránky používajú rovnaký dokument/zákazku. Publikácia nikdy neprepne na nesúvisiacu šablónu.
Portal Studio · Mapa pracovného priestoru
Živé plátnoPlocha · Zákazník
Portál zákazníkovRovnaký štruktúrovaný dokument použitý pri náhľade a verejnej kresbe
Mapa rozhrania: pracovná lišta, živé plátno a inšpektor sa zameriavajú na rovnakú stabilnú stránku a výber uzla.
Administrátor · Štart

Úplná pripravenosť pred budovaním hlboko

  1. Otvoriť Portál Studio → Štart → Reaktivita.
  2. Potvrďte adresu kanonického portálu a otvorte ju v osobitnej záložke.
  3. Nastavte logo, ikonu prehliadača, dotykovú ikonku, spoločenský obraz a farbu témy.
  4. Potvrdiť jazyky Help Center; zmeniť jazykovú autoritu v Help Centre, nie Studio.
  5. Nastaviť navigáciu a globálne podnikové pätky.
  6. Vyberte si cestu lístkom a nakonfigurujte aspoň jeden formulár žiadosti.
  7. Udržujte aspoň jednu bezpečnú metódu prihlásenia a preskúmajte zistenie totožnosti.
  8. Spustiť Kvalita a vytvoriť podpísaný náhľad ruky podanie.
  9. Vytvoriť prvé riadené vydanie po každej blokujúcej položke je jasné.

Percento pripravenosti sa vypočíta z uložených dát pracovnej plochy a stavu náhľadu. Výber trasy položiek priamo do vlastného panela.

Správca · Build

Zostavovať stránky a opakovane použiteľné sekcie

  1. Otvoriť Budovať → Stránky a vyberte chránenú stránku systému alebo vytvoriť vlastnú stránku.
  2. Nastaviť trasu, názov, prístupový režim a miestne správanie. Chránené systémové trasy nemožno odstrániť.
  3. Otvoriť Komponenty, filtrovať podľa zamestnania alebo splatnosti a umiestniť komponent do kompatibilného slotu.
  4. Použite inšpektora na obsah, vzhľad, viazanie, viditeľnosť a prístupnosť.
  5. Používajte opakovane použiteľné vzory pre opakované štruktúry; udržiavajte organizáciu alebo obchodné rozdiely vo variantoch.
  6. Uložiť návrh a cvičenie načítavanie, prázdne, chyba, hosť a prihlásený-in štáty v náhľade.
Komponent knižnica · Sanitizovaná mapa rozhrania
Hľadanie vedomostíGA · trezor zákazníkaSieť kategórieGA · Centrum pomociOrgán článkuGA · preložené DTOFormulár žiadostiGA · verziovanéČasová os vstupeniekBeta · varovanieDatabázová schémaPlánované · bloky publikované
Mapa rozhrania: kategória, kompatibilita a zrelosť sú viditeľné pred umiestnením. Plánované komponenty blokujú zverejnenie; beta zložky vyžadujú explicitné uvoľnenie liečby.
Administrátor · Značka a responzívna

Náhľad skutočné cesty, nie jedna šťastná obrazovka

  1. Vyberte si podporu hosťa, vstupenka s prihláseným podpisom, fakturačné služby, organizáciu alebo odovzdávanie vedomostí.
  2. Prepnúť osoby, organizácia, role a Help Center jazyk.
  3. Skontrolujte mobilné, veľké mobilné, tablet, laptop, desktop, široké a ultraširoké hraničné hodnoty.
  4. Skontrolujte zdedené, prehnané a resetované hodnoty; vyhnúť sa zbytočnému zdvojeniu bodov zlomu.
  5. Spustite klávesnicu, RTL, redukovaný pohyb, načítanie, prázdne, nedostupné a povolené stavy.
  6. Pred preskúmaním použite testovacie laboratórium na zistenie dostupnosti, užitočného zaťaženia, trasy, viazania a kresby.
Zelené plátno nie je rozhodnutie o uvoľnení. Rozhodol predlet, preskúmať stav, schopnosti a dôkazy o uvoľnení rozhodnúť, či portál môže zverejniť.
Administrátor · Skúsenosti

Prevádzkovať asistenčné centrum Zendesk bez duplicitného obsahu

  1. Vytvoriť kategórie, sekcie, články, preklady, prílohy a šablóny v Centrum pomoci.
  2. Povoliť jazyky tam; lokalizované slimáky, vyhľadávanie, kanály, SEO a článok chróm sledovať rovnakú autoritu.
  3. V štúdiu, miesto vyhľadávanie vedomostí, kategória / zdrojových sietí, kanály, téma akordeón, článok, obsah, spätná väzba, súvisiace a predchádzajúce / ďalšie komponenty.
  4. Nastaviť funkcie, populárne a nedávne kanály; použiť kontextové návrhy v tokoch lístkov.
  5. Náhľad žiadne výsledky, dlhé články, prílohy, spätná väzba, hodinky/predplatné a rozdávanie lístkov.
  6. Overiť čisté miestne trasy, kanonické / hreflang, štruktúrované dáta a cache invalidáciu po uverejnení.
Hranica orgánu: editovať obsah článku a zákaznícke jazyky v Help Center. Použite Portal Studio len na zostavenie toho, ako sa vedomosti objavujú a zobrazujú.
Administrátor · Identita a organizácie

Nastaviť bezpečné prihlásenie

  1. Otvoriť Identita a organizácie → Identita a udržiavať aspoň jednu prihlasovaciu dráhu zapnutú.
  2. Vyberte predvolenú metódu, politiku registrácie, trvanie sedenia, SSO_-doména presadzovanie a správanie objavov.
  3. Pridať poskytovateľov s vizuálnym smerovaním polí: typ, domény, priorita, prezentácia, povolené a overené stav. Tajomstvá zostať v subsystéme identity.
  4. Pre SCIM, povoliť zabezpečenie, skopírovať presný koncový bod pracovného priestoru a otáčať token. Uložte jednorazový token v IdP.
  5. Mapa tvrdí a členstvo v organizácii, potom test vytvoriť, aktualizovať, skupinové členstvo a deaktivácia s testovacím nájomcom.
  6. Pred uverejnením náhľad hosťa, zákazníka, delegovaná organizácia a blokované štáty.
Nikdy neposielajte súbor cookie so štúdiom SCIM. Je to bezsediaci, workspace-bound beader API Otočiť token po náhodnom vystavení.
Administrátor · Cesty vstupeniek

Kompletná podporná cesta

  1. Vyberte priamy formulár, sprievodca, vyhľadávač, uzol alebo servisný desk.
  2. Vytvorte pomenovaný, verziovaný formulár žiadosti s oddielmi a prístupnými štítkami.
  3. Zostavte vizuálne podmienky, smerovanie, SLA a schvaľovacie kroky; pokročilé JSON je len pre recenzované vývojové zmeny.
  4. Nastaviť zoznam, detaily, závit, časovú os, prílohu, schválenie, SLA a plochy odpovede.
  5. Vyhľadávanie hostí, prihlásenie žiadostí, viditeľnosť organizácie, zlyhanie nahrávania, e-mailové oznámenie a deformácia vedomostí.
  6. Uložiť návrh; publikovať len po traťový adaptér a oznam cesty prejsť predlet.
Administrátor · Preskúmanie a uvoľnenie

Presun cez riadené vydanie

Uložený návrhNa preskúmanieSchválenéPlánované alebo uverejnenéPozorované alebo valcované späť
  1. Spustiť validáciu a Test Lab. Fix blokovanie nálezov; Uznať povolené varovania s kontextom.
  2. Pridať poznámky k vydaniu a recenzia žiadosti. Recenzenti komentár na stabilnej stránky / node pathes.
  3. Schvaľovatelia kontrolujú diff, náhľad cesty, zmeny povolení a dôkazy.
  4. Publikovať alebo plánovať prostredníctvom pracovníka v pozadí. Opustenie Studio nezruší trvalé zamestnanie.
  5. Sledujte pokrok, zdravie a koreláciu ID. Zastaviť/zanechať iba z pracovných kontrol.
  6. Overiť kritické trasy, identity, vstupenky a vedomosti. Vrátiť späť do nemenného predchádzajúceho vydania v prípade potreby.
SchopnosťÚčel
Zobraziť / UpraviťSkontrolujte alebo zmeňte návrhy bez prepúšťacieho orgánu.
Preskúmanie/schválenieOddelená spätná väzba a súhlas autora.
Plán / Publikovať / RollbackNezávislé kontroly výroby.
Identita / SCIM / Migrate / Components / DiagnosticsObmedziť citlivé špecializované operácie.
Administrátor · Migrovať a rozšíriť

Migratuj s dôkazmi a cestou späť

  1. Vyberte plán poskytovateľa a vytvoriť suchý beh.
  2. Preskúmať objavené nastavenia, neskreslené hodnoty, počet obsahov a vizuálne parity zachytáva.
  3. Kompletné bezpečné mapovanie a reštart štruktúrované diff.
  4. Aplikujte na návrh, zmierte sa počíta a nájdite každú chránenú cestu.
  5. Zaznamenajte povolené prijatie; nikdy neprepisujte aktuálne publikované vydanie počas importu.
  6. Zverejniť prostredníctvom riadenia a udržať správu o migrácii, vydať ID a bod spätného odrazu dohromady.
Rozširovací sprievodca vývojárom · Architektúra

Rozšíriť zmluvy, nie vzory

Bezpečné rozšírenie registruje stabilný typ komponentu a schému, deklaruje práva a potreby dát, vykonáva prostredníctvom kanonického zostavovateľa a dodáva deterministické zariaďovacie/testy. Nehľadajte ľubovoľné tabuľky, vstrekujte editor JavaScript do verejného portálu, vytvoriť iný úložisko článkov, alebo obísť vypustenie brány.

Portál v2

Stránky obsahujú stabilné uzly, sloty, vlastnosti, väzby, citlivé prepisy, podmienky a metaúdaje o prístupnosti.

Register komponentov

Jedna zmluva podáva Studio, kompilátor, dokumentáciu, migráciu a kontrolu zrelosti.

Register zdrojov údajov

Povoliť nastavené, iba pre čítanie, DTO s rozlíšením oprávnenia nahrádzajú ľubovoľné SQL alebo dynamické akcie.

Jeden kresiteľ

Preview a verejné výstupy zdieľať zostavovanie, dezinfekcia, rozpočty a bežeckých štátov.

Developer · Zmluva o komponente

Definovať balík komponentov

Použite malé meno s medzerou ID a sémantickú verziu. Dodávame ako názvy kompatibility vlastnosti zobrazené, pretože kontrola balíka a bezpečnostné overenie vykonať 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 uzla

{
  "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"}
}
  • ID zostávajú stabilné v rámci úprav a migrácie.
  • Vlastnosti odmietajú neprihlásené polia a nebezpečné HTML.
  • Každý zobrazený dátami viazaný výstup definuje načítanie, prázdne, povolenie a spätno prístupný.
  • Kontajnerové komponenty označujú svoje sloty; listy nemôžu prijímať svojvoľné deti.
  • Označiť zrelosť úprimne: plánované bloky, beta varuje, GA vyžaduje úplné dôkazy.
Vývojár · Zdroje dát a väzby

Použiť DTO bezpečné pre povolenie

  1. Vyberte existujúce bodkované ID, ako je tickets.mine, knowledge.featured alebo customer.profile.
  2. Väzba iba polia deklarované jeho verziou DTO. Neznáme zdroje zlyhali s data_source.unknown.
  3. Prejdite kontext už povolené portálu; nikdy neakceptujte pracovnú plochu/zákazník identity z nedôveryhodného majetku.
  4. Limity zoznamu sú upnuté na. 1–100Normalizovať stránkovanie, locale a vyhľadávacie hodnoty.
  5. Ak je nový zdroj nevyhnutný, pridajte jeho stabilnú definíciu, bezpečné mapovanie, oprávnenia, prázdne správanie a náhľad zariadenie dohromady.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Zdroje dát sú len na čítanie. Mutácie vyžadujú explicitnú schválenú činnosť služby, viazanie pracovného priestoru, CSRF/schôdza alebo potvrdenie nositeľa, nejasnosti v prípade potreby a zadali chybové obálky.
Vývojár · Bezpečnosť

Zostaňte v hraniciach dôvery

HranicaPožadované správanie
Pracovný priestorOdobrať od dôveryhodného hostiteľa/route/schôdze, potom prehľadať každé čítanie a písať pred vykonaním.
HTMLPoužiť portálový sanitátor/parser povoľný zoznam. Nikdy konkatelizovať nedôveryhodné atribúty, URLs, CSS alebo scenár.
NáhľadPožadovať rovnaké-pôvod zdrojové okno, podpísanú verziu kanála a nonce. Ignorovať nevyžiadané správy.
IdentitaUdržujte tajomstvá mimo dokumentov. SCIM je nositeľom autentizovaný, bez sedenia a workspace-bound.
BaleniaOdmietnuť traversal, absolútne cesty, odkazy/špeciálne súbory, nadrozmerné archívy, kontrolný súčet/nesúlad podpisu a neznáme povolenia.
ChybyVrátiť stabilný kód, bezpečnú správu, spätnú platnosť, sanáciu a korelačné ID; prihlásiť súkromné výnimky server-strana.
VedomostiČítajte cez HelpCenterBridge. Nikdy nepíšete alebo nedvojnásobujete články Help Center v prípone.
{
  "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ár · Balík a migrácia

Inšpekcia, inštalácia a modernizácia atómovo

  1. Polož component.json na koreň ZIP a udržať všetky cesty relatívne.
  2. Spustiť inšpekciu ako prvý. Inštalatér caps archív na 500 zápisy a 25 MB extrahované; validácia bezpečnosti pridáva nezávislé limity.
  3. Overte si očakávaný SHA-256 a podpis balíka v procese vydania.
  4. Nainštalujte do verziovaného adresára. Nikdy nezmutujte nainštalovanú verziu na mieste.
  5. Poskytnite migráciu majetku pre rozbitie zmeny schémy a zachovať neznáme kompatibilitu polí.
  6. Otvorte zložku v návrhu, spustite každý štát/viewport/persona upínací prvok a publikujte prostredníctvom riadenia.
  7. Rollback aktivuje predchádzajúcu nemeniteľnú zložku/uvoľnenie dokumentu; zachová si dôkaz o reprodukovateľnosti.
Vývojár · Testy a uvoľnenie

Dokážte rozšírenie na rovnaké uvoľnenie hašiš

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 sú potrebné, nie je dostatočné. Pripojiť databázu/migráciu, real-browser vizuálny, identity-poskytovateľ, autorizácia-izolácia, prístupnosť, výkon, fronta/cron, mail/prijímanie, zálohovanie/restoru a nasadenie dôkazy do rovnakej hash nemennej vydanie. Neznáme požadované dôkazy musia zlyhať uvoľnenie.

  • Jednotka: schéma, sanitizácia, tvar DTO, podmienky, migrácia a zadané poruchy.
  • Zmluva: nakladanie/prázdne/error/úspech, splatnosť, sloty, viazanie a jednoponorkové parity.
  • Prehliadač: klávesnica, zameranie, sémantika, RTL, zoom/reflow, znížený pohyb a každý bod prestávky.
  • Bezpečnosť: multi-workspace sondy, kované akcie, útoky balíkov, náhľad spoofing a tajné únik.
  • Operácie: trvalý pokrok, odchod/návrat, zastavenie/retry/obnovenie, časový tep srdca a návrat.
Administrátor + Vývojár · Obnova

Problém podľa stavu a korelácie ID

StavČo robiť
PovoleniePožadujte pomenovanú schopnosť. Skryté UI je pohodlné; backend vždy presadzuje ju.
PotvrdenieOtvorte nahlásenú stránku/node/pole, opravte ju a potom znovu prebehnite predletom.
KonfliktZnovu načítať najnovšiu revíziu, porovnať zmeny a znovu podať úmyselne. Nikdy nenúťte prepísať.
Offline / revalableUdržujte návrh, obnoviť pripojenie, preskúšať prostredníctvom akcie a overiť trvalý stav zamestnania.
Fatálne/nedostupnéSkopírujte korelačné ID a časovú pečiatku pre podporu. Nikdy nevložte tajomstvo alebo súkromný text s výnimkou.
Zobraziť zlyhaloSkontrolujte predletový/pracovný výstup, skúste len opakovane vyskúšateľné fázy alebo sa vráťte späť do posledného zdravého uvoľnenia.
SCIM 401/403Potvrdiť koncový bod/pracovný priestor, token doručiteľa, povolený stav a rotáciu; nikdy nepoužívať cookie relácie prehliadača.
Vedomosti sú zastavené.Overte si lokalizáciu/zverejnenie v centre pomoci, potom skontrolujte invalidáciu vyrovnávacej pamäte a čistú lokalizovanú trasu.

Táto príručka je pripravená na tlač. Použite tlač → Uložte ako PDF pre kontrolovanú offline kópiu.