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.
Úplná pripravenosť pred budovaním hlboko
- Otvoriť Portál Studio → Štart → Reaktivita.
- Potvrďte adresu kanonického portálu a otvorte ju v osobitnej záložke.
- Nastavte logo, ikonu prehliadača, dotykovú ikonku, spoločenský obraz a farbu témy.
- Potvrdiť jazyky Help Center; zmeniť jazykovú autoritu v Help Centre, nie Studio.
- Nastaviť navigáciu a globálne podnikové pätky.
- Vyberte si cestu lístkom a nakonfigurujte aspoň jeden formulár žiadosti.
- Udržujte aspoň jednu bezpečnú metódu prihlásenia a preskúmajte zistenie totožnosti.
- Spustiť Kvalita a vytvoriť podpísaný náhľad ruky podanie.
- 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.
Zostavovať stránky a opakovane použiteľné sekcie
- Otvoriť Budovať → Stránky a vyberte chránenú stránku systému alebo vytvoriť vlastnú stránku.
- Nastaviť trasu, názov, prístupový režim a miestne správanie. Chránené systémové trasy nemožno odstrániť.
- Otvoriť Komponenty, filtrovať podľa zamestnania alebo splatnosti a umiestniť komponent do kompatibilného slotu.
- Použite inšpektora na obsah, vzhľad, viazanie, viditeľnosť a prístupnosť.
- Používajte opakovane použiteľné vzory pre opakované štruktúry; udržiavajte organizáciu alebo obchodné rozdiely vo variantoch.
- Uložiť návrh a cvičenie načítavanie, prázdne, chyba, hosť a prihlásený-in štáty v náhľade.
Náhľad skutočné cesty, nie jedna šťastná obrazovka
- Vyberte si podporu hosťa, vstupenka s prihláseným podpisom, fakturačné služby, organizáciu alebo odovzdávanie vedomostí.
- Prepnúť osoby, organizácia, role a Help Center jazyk.
- Skontrolujte mobilné, veľké mobilné, tablet, laptop, desktop, široké a ultraširoké hraničné hodnoty.
- Skontrolujte zdedené, prehnané a resetované hodnoty; vyhnúť sa zbytočnému zdvojeniu bodov zlomu.
- Spustite klávesnicu, RTL, redukovaný pohyb, načítanie, prázdne, nedostupné a povolené stavy.
- Pred preskúmaním použite testovacie laboratórium na zistenie dostupnosti, užitočného zaťaženia, trasy, viazania a kresby.
Prevádzkovať asistenčné centrum Zendesk bez duplicitného obsahu
- Vytvoriť kategórie, sekcie, články, preklady, prílohy a šablóny v Centrum pomoci.
- Povoliť jazyky tam; lokalizované slimáky, vyhľadávanie, kanály, SEO a článok chróm sledovať rovnakú autoritu.
- 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.
- Nastaviť funkcie, populárne a nedávne kanály; použiť kontextové návrhy v tokoch lístkov.
- Náhľad žiadne výsledky, dlhé články, prílohy, spätná väzba, hodinky/predplatné a rozdávanie lístkov.
- Overiť čisté miestne trasy, kanonické / hreflang, štruktúrované dáta a cache invalidáciu po uverejnení.
Nastaviť bezpečné prihlásenie
- Otvoriť Identita a organizácie → Identita a udržiavať aspoň jednu prihlasovaciu dráhu zapnutú.
- Vyberte predvolenú metódu, politiku registrácie, trvanie sedenia, SSO_-doména presadzovanie a správanie objavov.
- 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.
- Pre SCIM, povoliť zabezpečenie, skopírovať presný koncový bod pracovného priestoru a otáčať token. Uložte jednorazový token v IdP.
- Mapa tvrdí a členstvo v organizácii, potom test vytvoriť, aktualizovať, skupinové členstvo a deaktivácia s testovacím nájomcom.
- Pred uverejnením náhľad hosťa, zákazníka, delegovaná organizácia a blokované štáty.
Kompletná podporná cesta
- Vyberte priamy formulár, sprievodca, vyhľadávač, uzol alebo servisný desk.
- Vytvorte pomenovaný, verziovaný formulár žiadosti s oddielmi a prístupnými štítkami.
- Zostavte vizuálne podmienky, smerovanie, SLA a schvaľovacie kroky; pokročilé JSON je len pre recenzované vývojové zmeny.
- Nastaviť zoznam, detaily, závit, časovú os, prílohu, schválenie, SLA a plochy odpovede.
- Vyhľadávanie hostí, prihlásenie žiadostí, viditeľnosť organizácie, zlyhanie nahrávania, e-mailové oznámenie a deformácia vedomostí.
- Uložiť návrh; publikovať len po traťový adaptér a oznam cesty prejsť predlet.
Presun cez riadené vydanie
- Spustiť validáciu a Test Lab. Fix blokovanie nálezov; Uznať povolené varovania s kontextom.
- Pridať poznámky k vydaniu a recenzia žiadosti. Recenzenti komentár na stabilnej stránky / node pathes.
- Schvaľovatelia kontrolujú diff, náhľad cesty, zmeny povolení a dôkazy.
- Publikovať alebo plánovať prostredníctvom pracovníka v pozadí. Opustenie Studio nezruší trvalé zamestnanie.
- Sledujte pokrok, zdravie a koreláciu ID. Zastaviť/zanechať iba z pracovných kontrol.
- 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álenie | Oddelená spätná väzba a súhlas autora. |
| Plán / Publikovať / Rollback | Nezávislé kontroly výroby. |
| Identita / SCIM / Migrate / Components / Diagnostics | Obmedziť citlivé špecializované operácie. |
Migratuj s dôkazmi a cestou späť
- Vyberte plán poskytovateľa a vytvoriť suchý beh.
- Preskúmať objavené nastavenia, neskreslené hodnoty, počet obsahov a vizuálne parity zachytáva.
- Kompletné bezpečné mapovanie a reštart štruktúrované diff.
- Aplikujte na návrh, zmierte sa počíta a nájdite každú chránenú cestu.
- Zaznamenajte povolené prijatie; nikdy neprepisujte aktuálne publikované vydanie počas importu.
- Zverejniť prostredníctvom riadenia a udržať správu o migrácii, vydať ID a bod spätného odrazu dohromady.
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.
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.
Použiť DTO bezpečné pre povolenie
- Vyberte existujúce bodkované ID, ako je
tickets.mine,knowledge.featuredalebocustomer.profile. - Väzba iba polia deklarované jeho verziou DTO. Neznáme zdroje zlyhali s
data_source.unknown. - Prejdite kontext už povolené portálu; nikdy neakceptujte pracovnú plochu/zákazník identity z nedôveryhodného majetku.
- Limity zoznamu sú upnuté na. 1–100Normalizovať stránkovanie, locale a vyhľadávacie hodnoty.
- 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"}
]
}
Zostaňte v hraniciach dôvery
| Hranica | Požadované správanie |
|---|---|
| Pracovný priestor | Odobrať od dôveryhodného hostiteľa/route/schôdze, potom prehľadať každé čítanie a písať pred vykonaním. |
| HTML | Použiť portálový sanitátor/parser povoľný zoznam. Nikdy konkatelizovať nedôveryhodné atribúty, URLs, CSS alebo scenár. |
| Náhľad | Požadovať rovnaké-pôvod zdrojové okno, podpísanú verziu kanála a nonce. Ignorovať nevyžiadané správy. |
| Identita | Udržujte tajomstvá mimo dokumentov. SCIM je nositeľom autentizovaný, bez sedenia a workspace-bound. |
| Balenia | Odmietnuť traversal, absolútne cesty, odkazy/špeciálne súbory, nadrozmerné archívy, kontrolný súčet/nesúlad podpisu a neznáme povolenia. |
| Chyby | Vrá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"}
}
}
Inšpekcia, inštalácia a modernizácia atómovo
- Polož
component.jsonna koreň ZIP a udržať všetky cesty relatívne. - 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.
- Overte si očakávaný SHA-256 a podpis balíka v procese vydania.
- Nainštalujte do verziovaného adresára. Nikdy nezmutujte nainštalovanú verziu na mieste.
- Poskytnite migráciu majetku pre rozbitie zmeny schémy a zachovať neznáme kompatibilitu polí.
- Otvorte zložku v návrhu, spustite každý štát/viewport/persona upínací prvok a publikujte prostredníctvom riadenia.
- Rollback aktivuje predchádzajúcu nemeniteľnú zložku/uvoľnenie dokumentu; zachová si dôkaz o reprodukovateľnosti.
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.
Problém podľa stavu a korelácie ID
| Stav | Čo robiť |
|---|---|
| Povolenie | Požadujte pomenovanú schopnosť. Skryté UI je pohodlné; backend vždy presadzuje ju. |
| Potvrdenie | Otvorte nahlásenú stránku/node/pole, opravte ju a potom znovu prebehnite predletom. |
| Konflikt | Znovu načítať najnovšiu revíziu, porovnať zmeny a znovu podať úmyselne. Nikdy nenúťte prepísať. |
| Offline / revalable | Udrž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ť zlyhalo | Skontrolujte 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/403 | Potvrdiť 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.