←Lahat ng Dokumento
Portal Studio gabay sa patlang

Magtayo nang may katapangan.

Isang praktikal na reperensiya para sa mga administrador na humubog sa karanasan at mga tagapagpaunlad ng customer na nagpapalawig nito. Ito ay nagtatala ng tunay na arkitekturang Studio, pinamamahalaang landas na pang-laya, Pagmamay-ari ng Sentrong Help, pagkakakilanlan, pandarayuhan, mga kontratang pang-edukasyon at pagbawi.

Portal Document va2Administrator + MalinangAng enterprise release dropInupdate 1 Agosto 2026
Administrator na giya · Arkitektura

Alamin kung ano ang pag - aari ng Studio

Ang Portal Studio ang nagmamay-ari ng customer-facing shell: mga pahina, sangkap na paglagay, markang pananda, tumutugong pag-uugali, nabigasyon, footer, representasyon ng pagkakakilanlan, paglalakbay at pagpapalabas ng tiket. Ang Help Center ay nagmamay-aring mga wika, kategorya, seksiyon at nilalamang artikulo. inaubos ng Studyo ang nilalamang iyon sa pamamagitan ng isang protektadong tulay; hindi ito lumilikha ng pangalawang tindahan ng artikulo.

Tulong Center + tiket + serbisyo ng pagkakakilanlanPagpapahintulot-ligtas na mga taga-angkop ng datosPortal Document va2 draftIsang Tagapagtipon at tagapag - abuloyPatiunang Ituon ang pansin at inilathala ang Portal
Isang-aberong alituntunin: Ang mga preview at pampublikong pahina ay gumagamit ng parehong dokumento/compiler contract. Ang publication ay hindi kailanman nag-ebolb sa isang walang kaugnayang template.
Portal Studio · Mapa ng workspace
Matabang canvasDesktop ·tagapagsanay
Ang Kaugaliang PortalAng parehong isinaayos na dokumento na ginamit sa patiunang pagsusuri at pangmadlang salin
Interface map: ang work rail, live canvas at inspektor target ang parehong matatag na pahina at node selection.
Administratibo · Magsimula

Maging handang - handa bago magtayo nang malalim

  1. Buksan Portal Studio → Magsimula → Pagiging Handa.
  2. Tiyakin ang kanonikal na direksiyong Portal at buksan ito sa isang hiwalay na tab.
  3. Ilagay ang logo, browser icon, touch icon (larawang pang-ekonomiya), larawan sa lipunan at ang kulay ng tema.
  4. Kumpilan ang mga wikang Help Center; baguhin ang awtoridad ng wika sa Help Sentro, hindi sa Studio.
  5. Ang paglalayag sa pamamagitan ng mga kahon at ang global conbuilt footer.
  6. Pumili ng tiket at isaayos ang kahit isang anyong kahilingan.
  7. Panatilihing aktibo ang kahit isang ligtas na sign-in method at repasuhin ang pag-aaklas ng pagkakakilanlan.
  8. Tumawid sa Kalidad at tiyakin ang nakapirmang pakikipagkamay.
  9. Gumawa ng unang demand release matapos malinaw ang bawat bagay na pangharang.

Ang mga advance porsyento ay kinakalkula mula sa nasagip na datos ng workspace at preview state. pagpili ng isang item ruta direkta sa kanyang sariling panel.

Administrador · Magtayo

Gumawa ng mga pahina at muling - gamitin

  1. Buksan Magtayo → Mga Pahina at pumili ng isang pahina ng protektadong sistema o lumikha ng isang customy page.
  2. Magtakda ng ruta, titulo, access mode at locame role.
  3. Buksan Mga Komponente, salain sa pamamagitan ng trabaho o pagkamaygulang, at ilagay ang isang sangkap sa isang magkabagay na slot.
  4. Gamitin ang inspektor para sa nilalaman, hitsura, pagtatali, nakikita at madaling daanan.
  5. Gumamit ng mga disenyong maaaring gamiting muli para sa paulit - ulit na mga istraktura; panatilihin ang organisasyon o pagkakaiba - iba ng tatak sa iba't ibang uri.
  6. Iligtas ang draft at ehersisyo na nagkarga, walang laman, error, bisita at signed-in states sa preview.
Kapundong aklatan · Sanitisadong interface map
Paghahanap ng kaalamanGA · parokyano ligtasKategoryang gridGA · Sentro ng TulongBakumentong katawanGA · isaling DTOHiniling na anyoGA · bersyonedKumpas na timelineBeta · babalatsart ng mga DataIsinaplanong · blocks na inilalathala
Interface map: kategorya, kompetsibilidad at pagkamaygulang ay nakikita bago ilagay. Planned na mga bahagi block publikasyon; beta mga sangkap ay nangangailangan ng malinaw na release treatment.
Administrastador · Brand at tumutugon

Isipin ang tunay na mga paglalakbay, hindi ang isang masayang iskrin

  1. Pumili ng suportang panbisita, pumirma-in tiket, billing care, organisasyon o kaalamang manu-sup.
  2. Stwitch personas, organisasyon, papel at wikang Help Center.
  3. Sa spectable mobile, malaking mobile, tablet, laptop, desktop, malawak at napakalawak na mga breakpoint.
  4. Suriin ang minana, nangingibabaw at nakaayos na mga pamantayan; iwasan ang di - kinakailangang pagbuwag ng mga ari - arian.
  5. Run keyboard, RTL, nabawasang-motion, pagkarga, bakante, walang trabaho at mga estadong may pahintulot.
  6. Gamitin ang Test Lab para sa accessable, payload, ruta, pag-aanalisa at pagbibigay ng mga natuklasan bago repasuhin.
Hindi isang malayang desisyon ang paggawa ng berdeng kambas. hinogur ang preflight, review state, mga kakayahan at pagpapalabas ng ebidensiya kung maaaring ilathala ng Portal.
Administratibo · Karanasan

Operate isang Zendesk-level Help Center nang walang nagayang nilalaman

  1. Gumawa ng mga kategorya, seksiyon, artikulo, salin, kagamitan at template Sentro ng Tulong.
  2. Ang mga wikang madaling gamitin doon; ang lokal na glue, paghahanap, pagpapakain, SEO at artikulo ay sumusunod sa iisang awtoridad.
  3. Sa Studio, ilagay ang kaalaman sa paghahanap, kategorya/resource grids, pagpapakain, top perpendition, artikulo, mesa ng nilalaman, feedback, kaugnay at naunang/next na mga bahagi.
  4. Ang konfigure ay nagtatampok, popular at kamakailan lamang ay nagpakain; gumamit ng kontekstong mga mungkahi sa daloy ng tiket.
  5. Preview no-results, mahahabang artikulo, mga nakakabit, mga feedback, relo/suprition at handoff ng tiket.
  6. Ibalik-pantay ang malinis na mga ruta ng locale, kanonikal/hreflang, naka-ayos na datos at cache infigration matapos ilathala.
Hangganan ng autoridad: I - edit ang nilalaman ng artikulo at mga wika ng parokyano sa Help Center. Gamitin ang Portal Studio para lang makabuo kung paano natutuklasan at maipakikita ang kaalaman.
Administrador · pagkilala at mga organisasyon

Configure sign-in ligtas

  1. Buksan Pagkakakilanlan at mga organisasyon → Pagigingidentidad at panatilihin ang kahit isang sign-in path ay nakapagdurulot.
  2. Pumili ng default method, patakaran sa pagpaparehistro, sesyon, SSO-domain ang pagpapatupad at pagtuklas ng gawi.
  3. Ang mga provider na may nakikitang glovating fields: type, domains, prioridad, presentasyon, maketo at makumpirmang estado. Ang mga lihim ay nananatili sa subsistema ng pagkakakilanlan.
  4. Sapagkat SCIM, nakapagbibigay-kaya, kumopya ng eksaktong workspace endpoint at umiikot sa token. i-imbak ang one-time token sa IdP.
  5. Ang mga pag-aangkin ng Mapa at kasapi sa organisasyon, pagkatapos ay ang pagsubok ay lumilikha, nag-apruba, miyembro ng grupo at deaktibsyon na may test tenant.
  6. Bago ilathala, ang mga panauhing preview, parokyano ay nag-aatas ng organisasyon at mga estadong barado bago ang paglalathala.
Huwag na huwag magpadala ng isang sheokie sa Studio SCIM. Ito ay isang walang sesyon, workspace-bound bearer API. Ibuto ang isang token pagkatapos ng aksidenteng paglalantad.
Administrastador · Mga paglalakbay sa Ticket

I - adjust ang buong biyahe para sa suporta

  1. Pumili ng direktang anyo, wank, search-first, stain o service-desk inclusion.
  2. Gumawa ng pangalan, na may bersyong anyong request na may mga seksiyon at madaling makuhang etiketa sa larangan.
  3. Gumawa ng mga visual na kalagayan, paglupig, SLA at pagsang - ayon; sumulong JSON ay para lamang sa mga pagbabagong ginawa sa pamamagitan ng review.
  4. Kabihasnan, detalye, sinulid, timeline, pagkabit, pagsang-ayon, SLA at tugon ay lumilitaw.
  5. Tumungo sa viewup, signed-in requests, visual, upload failure, email notification at kaalaman division.
  6. Magtipid ng draft; ilathala lamang pagkatapos na ang ruta ay pumasa sa preflight (pag - aayos) at notasyon.
Administrador · Repaso at paglabas

Maglakad sa pamamagitan ng isang pinamamahalaang paglaya

Naligtas ang DraftSa pagrerepasoSinang - ayunanIsinaayos o inilathalaManood o magpagulung - gulong
  1. Mag - ingat sa mga natuklasan; kilalanin ang ipinahihintulot na mga babala taglay ang konteksto.
  2. Idagdag ang mga release notes at request review. Ang mga taga-review ay nagkokomento sa matatag na pahina/node pathways.
  3. Sinusuri ng mga sumasang - ayon ang daambakal, patiunang nakikita ang mga paglalakbay, pinapayagan ang mga pagbabago at katibayan.
  4. Ang paglisan sa Studio ay hindi nagkansela ng matibay na trabaho.
  5. Mag-ingat sa pagsulong, kalusugan at correlation ID. top/retry lamang mula sa mga kontrol sa trabaho.
  6. Ibalik sa dati ang mga rutang kritikal, pagkakakilanlan, tiket at kaalaman. Igulong sa isang hindi nagbabagong premise release kapag kinakailangan.
May KakayahanLayunin
Larawan / KagitInspeksiyunin o baguhin ang mga draft nang walang inilabas na awtoridad.
Repaso / Sinasang - ayunanIbukod ang impormasyon at pagsang - ayon mula sa awtor.
Iskedyul / Publish / RollbackIndependiyenteng mga kontrol sa produksiyon.
Pagkakakilanlan / SCIM / Nandayuhan / Mga Konsepsiyoniko / DiagnostikoHuwag mag - opera nang sensitibo.
Administrador · Mangingibang - bansa at umaabot

Nandayuhan na taglay ang ebidensiya at daan pabalik

  1. Pumili ng provider plan at gumawa ng dry run.
  2. Natuklasan ng Review ang mga setting, hindi naitatakdang mga halaga, nilalaman at nakikitang pagkakapareho.
  3. Kumpletuhin ang ligtas na mga pagsasamapa at muling itakbo ang nakaayos na diff.
  4. Sa pamamagitan ng pag - iikid, pakikipagkasundo at patiunang pagsusuri sa bawat protektadong paglalakbay.
  5. Isulat ang awtorisadong pagtanggap; huwag kailanman isulat ang kasalukuyang inilathalang inilabas sa panahon ng pag - aangkat.
  6. Pumunta sa governence at panatilihin ang ulat ng pandarayuhan, ilabas ang ID at rollback point nang magkasama.
Malinang na gabay sa extension · Arkitektura

Mga kontratang may mahabang haba, hindi mga template

Ang isang ligtas na extension ay nagtatala ng isang matatag na composure type at schema, nagpapahayag ng mga pahintulot at mga pangangailangan sa datos, nag-eensayo sa pamamagitan ng kanonikal na tagatipon, at suplay deterministic integrates/testests. Huwag mag-query dialect ng mga mesa, iiniksiyon ng editor JavaScript sa publikong Portal, lumikha ng isa pang artikulo, o lumampas sa tarangkahang labasan.

Portal Document va2

Ang mga pahina ay naglalaman ng matatag na nodes, slots, mga katangian, mga pagtatali, tumutugong mga surpasiyo, mga kondisyon at accessable metadata.

Kahusayan sa Pagrerehistro

Ang isang kontrata ay nagbibigay ng mga tseke sa Studio, pagtitipon, dokumentasyon, pandarayuhan at pagkamaygulang.

Muling Pagrehistro ng Pinagmumulan ng Data

Pinapahintulutan, basahin-lamang, palitan ng pahintulot-scoped DTOs ang hindi tanggap na kagustuhan SQL o dinamikong pagkilos.

Isang tagapamahagi

Ang preview at pampublikong output ay nagbabahagi ng mga competment, sanitization, budgets at runtime states.

Linangin · Mag - asawa

Itakda ang isang paketeng bahagi

Gumamit ng mas mababang case namespaced ID at semantikong bersyon. supply kapwa competition propety show dahil ang inspeksiyunasyon ng pakete at seguridad ay gumagawa ng independiyenteng mga tseke.

{
  "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}
}

Hugis node

{
  "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"}
}
  • Nananatiling matatag ang mga ID sa mga pagsasaayos at pandarayuhan.
  • Itinatakwil ng mga matuwid ang di - ipinahayag na mga larangan at hindi ligtas HTML.
  • Ang bawat data-bound na pananaw ay nagbibigay ng kahulugan sa pagkarga, bakante, pahintulot at retryable-error output.
  • Ang mga bahaging may sangkap na lalagyan ay bumabanggit ng kanilang mga slot; ang mga dahon ay hindi maaaring tumanggap ng di - makatuwirang mga bata.
  • Mapagkakatiwalaang tandaan: isinaplanong mga bloke, babala ng beta, ang GA ay nangangailangan ng ganap na katibayan.
Linangin ang · Data sources at mga pabalat

Gamitin ang permit-ligtas na DTOs

  1. Pumili ng isang uncented na ID gaya ng tickets.mine, knowledge.featured o customer.profile.
  2. Ang mga bundante lamang na ipinahayag ng bersyon nito na DTO. ang hindi kilalang mga mapagkukunan ay nabibigo sa data_source.unknown.
  3. Pasahin ang na-indibidwal na kontekstong Portal; huwag kailanman tanggapin ang workspace/customer identity mula sa isang hindi ipinagkatiwalang propesyunal.
  4. Ang mga limitasyon sa listahan ay tinatakdaan1–100. Normalisado ang pograsyon, lokale at paghahanap ng mga halaga.
  5. Kung ang isang bagong pinagmumulan ay hindi maiiwasan, idagdag pa ang matatag na kahulugan nito, ligtas na pagsasama - sama ng mapa, mga pahintulot, walang - katuturang paggawi at patiunang pag - iisip na magkasama.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Ang mga pinagkukunan ng impormasyon ay binabasa-lamang. Ang mga mutasyon ay nangangailangan ng isang maliwanag na awtorisadong aksiyong serbisyo, workspace confix, CSRF/session o bearer facturement, idempotensiya kung saan kinakailangan at isang typed error envelope.
Linangin ang Katiwasayan

Manatili sa loob ng mga hangganan ng pagtitiwala

hanggananKailangang paggawi
Lugar ng TrabahoPagpasiya mula sa pinagkakatiwalaang host/route/pag-aalsa, pagkatapos ay saklawin ang bawat pagbasa at pagsusulat bago patayin.
HTMLGamitin ang Portal sanitizer/parser pinahihintulutan ang olist. Huwag kailanman i-contate ang mga hindi ipinagkatiwalang katangian, URLs, CSS o iskrip.
Patiunang Pag - isipanHinihiling ang parehong-origin source window, nilagdaan channel bersyon at mga disposable. ipagwalang-bahala ang hindi hinihinging mga mensahe.
PagkakakilanlanItago ang mga lihim sa labas ng mga dokumento. SCIM ay bearer-authenticated, converseless at workspace-bound.
Mga paketeItakwil ang mga daanan, absolutong landas, link/special files, oversize archives, checkum/signature mismatch at hindi alam na pinahihintulutan.
Mga PagkakamaliIbalik ang matatag na kodigo, ligtas na mensahe, muling pag-aaral, rekombinasyon at correlation ID; log pribadong eksepsiyon server-side.
KaalamanBasahin sa isang karugtong ang mga artikulo ng HelpCenterBridge.
{
  "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"}
  }
}
Linangin · Mag - anak at mandayuhan

Sa pag-spect, i-install at i-upgrade ng atomicly

  1. Ilagay component.json sa ugat ng ZIP at pinananatili ang bawat landas na kamag-anak.
  2. Una muna'y siyasatin ang mga arkibo ng installer capes 500 Mga Kabilang at 25 MB Hinango; ang segmentasyon ng seguridad ay nagdaragdag ng mga independiyenteng limitasyon.
  3. Verify the expected SHA-256 and package signature in the release process.
  4. Iluklok sa isang versioned directory. Huwag na huwag i-stat ang naka-install na bersyon sa lugar.
  5. Maglaan ng mga pandarayuhang pag-aari para sa pagkasira ng mga pagbabagong schema at pagpapanatili ng hindi kilalang mga larangang pang-kompetensiya.
  6. Buksan ang sangkap sa isang draft, patakbuhin ang bawat estado/viewport/persona instructed at ilathala sa pamamagitan ng governance.
  7. Pinatatakbo ng Rollback ang naunang di-nababagong sangkap/dokumentong pagpapalabas; panatilihin ang ebidensiyang reproduktibo nito.
Linangin ang mga Pagsubok at ilabas

Patunayan ang extension sa parehong release 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

Ang mga pintuan ng pagkukunan ay kinakailangan, hindi sapat. Attach database/migration, real-bowser visual, identity-provider, inference-isolation, accessable, performance, queue/cron, mail/attachment, backup/restore at depostment na katibayan sa parehong immutable release hash. Ang di kilalang kailangan na ebidensiya ay dapat mabigo ang release.

  • Unit: schema, sanitization, hugis DTO, kondisyon, pandarayuhan at mga stailed failure.
  • Kontrata: pagkarga/walang-sala/error/tagumpay, kagulangan, slots, friget at isang-render paridad.
  • Browser: keyboard, pokus, semantiks, RTL, zoom/reflow, nabawasang paggalaw at bawat breakpoint.
  • Seguridad: cross-workspace probes, mga pekeng aksiyon, mga atake ng pakete, itsek ang spoofing at lihim na pag-screase.
  • Mga operasyon: matibay na pagsulong, leave/return, top/retry/resume, regulator tibok ng puso at rollback.
Administrador + Tagapaglinang · Paggaling

Kaguluhang pinaputukan ng estado at correlation ID

KalagayanKung ano ang gagawin
PagpapahintulotAng paghiling ng pangalan. Naka-rerelaks ang nakatagong UI; laging ipinatutupad ito ng backend.
PagsasaayosBuksan ang iniulat na pahina/node/field, ituwid ito, pagkatapos ay muling tumakbo bago ang stage.
LabananI - download ang pinakabagong rebisyon, ikumpara sa iba ang mga pagbabago at gawin ito nang tama.
Offline / puwedeng baguhinPanatilihin ang draft, ibalik ang pagiging magkakaugnay, muling ayusin sa pamamagitan ng aksiyon at tiyakin ang matatag na kalagayan ng trabaho.
Nakamamatay ba ang mga Ito?Kopyahin ang correlation ID at pamamagitan para sa suporta. Huwag kailanman i-steats o pansariling eksepsiyon na teksto.
Bigo ang PublishIprinising preflight/job output, muling bigyan ng panibagong-buhay na mga yugto lamang, o gumulong pabalik sa huling malusog na paglabas.
SCIM 401/403Ang tiyak na endpoint/workspace, tagapagdala ng token, ay nakapagdulot ng estado at ikot; hindi kailanman gumamit ng browser session cookie.
Ang kaalaman ay wala nang bisaIbalik-tanaw ang lokale/publication sa Help Center, pagkatapos ay inspeksiyunin ang cache defiction at ang malinis na lokalisadong ruta.

Ang gabay na ito ay limbag-handa. Gamitin ang Palimbagan → Save bilang lisensya PDF para sa isang kontroladong kopya ng offline.