← Цялата документация
Портално студио

Издателство, безопасно.

Една практическа справка за администратори, които оформят клиентския опит и разработчиците, които го разширяват. Тя документира истинската архитектура на Студио, управлява пътя на освобождаване, собствеността на Центъра, идентичността, миграцията, договорите за компоненти и възстановяването.

Портален документ v2Администратор + РазработчикРаботен поток на предприятиетоОбновяване 1 Август 2026
Администраторски наръчник · Архитектура

Знаеш ли какво притежава Студио

Портал студио притежава клиентско-обличителната обвивка: страници, компонентно поставяне, маркови символи, отзивчиво поведение, навигация, подметка за самоличност, представяне на билети и релийзи. Центърът за помощ притежава езици, категории, секции и съдържание на статии. Студиото консумира това съдържание чрез защитен мост; никога не създава втори магазин за статии.

Помощен център + билет + услуги за самоличностАдаптори за безопасно използване на данниПроект на портален документ v2Един компилатор и рендиранеПреглед и публикуван портал
Правило на един търговец: Преглед и публични страници използват един и същ документ/договор за компилатор. Публикацията никога не преминава към несвързан шаблон.
Портално студио · Карта на работното място
Живо платноРаботен плот · Клиент
Портал на клиентиСъщият структуриран документ, използван при прегледа и публичното представяне
Интерфейсна карта: ЖП линията на работа, жив платно и инспектор цел една и съща стабилна страница и възел избор.
Администратор · Старт

Пълна готовност преди да се изгради дълбоко

  1. Отваряне Портал студио → Начало → Готовност.
  2. Потвърдете адреса на каноничния портал и го отворете в отделен раздел.
  3. Задайте логото, иконата на браузъра, докоснете икона, социален образ и цвят на темата.
  4. Потвърдете Help Center езици; промяна езиков орган в Центъра за помощ, а не студио.
  5. Настройване на навигацията и глобалния предприемач.
  6. Изберете билет пътуване и конфигурирайте поне една заявка форма.
  7. Съхранявайте поне един безопасен метод за влизане активен и преглед на откриването на самоличността.
  8. Стартирай Качеството и установи подписаното ръкостискане.
  9. Създаване на първото регулирано освобождаване след всеки блокиращ елемент е ясно.

Процентът на готовност се изчислява от записани данни за работното пространство и състояние на преглед. Избиране на маршрут директно към своя панел.

Администратор · Изграждане

Изграждане на страници и повторно използване секции

  1. Отваряне Изграждане → Страници и изберете защитена системна страница или да създадете обичайна страница.
  2. Задаване на маршрут, заглавие, режим на достъп и поведение на място. Защитените системни пътища не могат да бъдат изтрити.
  3. Отваряне Компоненти, филтър по работа или зрялост, и да постави компонент в съвместим слот.
  4. Използвайте инспектора за съдържание, външен вид, свързване, видимост и достъпност.
  5. Използвайте повторно използваеми модели за повтарящи се структури; поддържайте организацията или разликата в марката варианти.
  6. Запис на проекта и упражнение зареждане, празен, грешка, гост и записани в състояния в preview.
Компонентна библиотека · Карта на санитарен интерфейс
Търсене на знанияGA · сейф за клиентиКатегория на координатната мрежаGA · Център за помощТяло на статиятаGA · преведен DTOФормуляр за исканеGA · версияВремева линия на билетаБета · предупреждениеГрафика с данниПланирани · блокове публикува
Интерфейсна карта: категория, съвместимост и падеж са видими преди поставяне. Планирани компоненти блок публикуване; бета компоненти изискват изрично освобождаване лечение.
Администратор · Марка и отзивчив

Преглед на реални пътувания, нито един щастлив екран

  1. Изберете подкрепа за гости, подписан билет, грижа за фактуриране, организация или предаване на знания.
  2. Превключване персонажи, организация, роля и Help Center език.
  3. Огледайте мобилните, големи мобилни, таблети, лаптоп, десктоп, широки и ултрашироки гранични пунктове.
  4. Проверка на наследени, пренаселени и нулирани стойности; избягване на ненужните точки дублиране.
  5. Пусни клавиатурата, RTL, намалена скорост, зареждане, празно, недостъпно и с разрешение.
  6. Използвайте тестовата лаборатория за достъпност, полезен товар, маршрут, свързване и извършване на констатации преди преглед.
Управляван преди полета, преглед на състоянието, възможностите и освобождаването доказателства решават дали порталът може да публикува.
Администратор · Опит

Управление на Център за помощ Zendesk ниво без дублирано съдържание

  1. Създаване на категории, раздели, статии, преводи, прикачени файлове и шаблони в Център за помощ.
  2. Включване на езици там; локализирани плужеци, търсене, фуражи, SEO и статия хром следват една и съща власт.
  3. В Студио, поставете търсене на знания, категория / ресурси мрежи, емисии, тема акордеон, статия, таблица на съдържанието, обратна връзка, свързани и предишни/следващи компоненти.
  4. Настройване на функции, популярни и скорошни емисии; използвайте контекстуални предложения в потоците билети.
  5. Преглед на резултатите, дълги статии, прикачени файлове, обратна връзка, часовник/ Абонамент и фиш за предаване.
  6. Проверете чистите локални маршрути, каноничния/хрефланг, структурирани данни и кеш-ове в невалидност след публикуване.
Гранична стойност на органа: редактиране на съдържанието на статията и потребителските езици в Help Center. Използвайте Portal Studio само за да композирате как се открива и показва знанието.
Администратор · Идентификация и организации

Настройване на безопасно въвеждане

  1. Отваряне Идентичност и организации → Идентификация и да поддържа поне един вход включен.
  2. Изберете метод по подразбиране, политика за регистрация, продължителност на сесията, SSO- Главно управление и поведение на откритието.
  3. Добавете доставчици с визуални полета за маршрутизиране: тип, домейни, приоритет, представяне, активирано и проверено състояние. Тайните остават в подсистемата за идентичност.
  4. За SCIM, да се даде възможност за предоставяне, копирайте точната крайна точка на работното пространство и завъртете жетон.
  5. Карта вземания и организация членство, след това тест създавате, актуализирате, членство в група и изключване с тест наемател.
  6. Преглед на гостите, клиентите, делегираните организации и блокираните държави преди публикуване.
Никога не изпращай бисквитка на Студио сесия SCIM. Той е безсесиен, bounding работно пространство носител API Завъртете знак след случайно излагане.
Администратор · Пътувания с билети

Композирайте пълното поддържащо пътуване

  1. Изберете директна форма, магьосник, първо търсене, хъб или сервизно бюро.
  2. Създаване на именна, версия на формуляр за заявка с раздели и достъпни етикети.
  3. Изграждане на визуални условия, маршрутизиране, SLA и стъпки за одобрение; напреднали JSON е само за преразгледани промени в разработчиците.
  4. Настройване на списъка, детайл, конец, времева линия, закрепване, одобрение, SLA и отговори повърхности.
  5. Тест гост проверка, записани в заявки, организация видимост, качване на неуспех, имейл уведомление и отклонение на знанията.
  6. Запис на проект; публикувайте само след като адаптера за маршрута и път за уведомяване премине преди полета.
Администратор · Преглед и освобождаване

Преминаваме през контролирано освобождаване

Проект на записВ рамките на преразглежданетоОдобренНасрочено или публикуваноНаблюдавани или валцувани обратно
  1. Стартирайте валидирането и тестовата лаборатория. Поправете блокиращите констатации; потвърдете разрешените предупреждения с контекст.
  2. Добави бележки за освобождаване и искане преглед. Reviewers коментират стабилни страници / анод пътеки.
  3. Одобрените инспектират диференциала, превю пътуванията, промените в разрешението и доказателствата.
  4. Издателство или график чрез фоновия работник.
  5. Гледайте напредъка, здравето и корелационното разпознаване.
  6. Проверете критични маршрути, идентичност, билети и знания.
ВъзможностЦел
Изглед / РедактиранеПреглед или промяна на проекти без освобождаване орган.
Преглед / ОдобряванеОтделете обратна връзка и одобрение от авторството.
График / Издателство / Обратна връзкаНезависим контрол на производството.
Самоличност / SCIM / Миграция / Компоненти / ДиагностикаОграничи чувствителните специализирани операции.
Администратор · Миграция и разширяване

Мигирайте с доказателства и път назад

  1. Изберете план на доставчика и да се създаде сух пробег.
  2. Преглед на открити настройки, нематографирани стойности, брой съдържание и визуални париоценъчни улови.
  3. Пълна безопасна карта и повторно да се повтаря структурирана diff.
  4. Кандидатствайте за проект, съгласувайте броя и прегледайте всяко защитено пътуване.
  5. Запис на разрешено приемане; никога не презапишете текущото публикувано съобщение по време на внос.
  6. Публикувайте чрез управление и поддържайте доклада за миграцията, пуснете ID и rollback точка заедно.
Разработка на екстеншънен водач · Архитектура

Разширяване на договорите, а не шаблони

Безопасно разширение регистрира стабилен тип компонент и схема, декларира разрешения и нужди от данни, прави чрез каноничен компилатор, и доставя детерминистични тела / тестове. Не се изисква произволни таблици, инжектира редактор JavaScript в публичния портал, създайте друг регистър на статии, или заобикалят вратата за освобождаване.

Портален документ v2

Страниците съдържат стабилни възли, слотове, свойства, подвързвания, реагиращи настройки, условия и метаданни за достъпност.

Регистър на компонентите

Един договор подхранва студио, компилатор, документация, миграция и проверка на падеж.

Регистър на източника на данни

Включени, само за четене, позволени DTO заместват произволно SQL или динамични действия.

Един превод

Преглед и компилация на публични акции, саниране, бюджети и състояния за изпълнение.

Разработка · Договор за компонент

Определяне на компонентен пакет

Използвайте имена с малки букви ID и семантична версия. Доставяйте както имената на имотите за съвместимост, показани, защото пакетната проверка и валидирането на сигурността извършват независими проверки.

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

Форма на възела

{
  "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"}
}
  • Идентифицирането остава стабилно в различните редактори и миграции.
  • Имотите отхвърлят недекларираните полета и не са безопасни HTML_.
  • Всеки вързан с данни изглед определя зареждането, празното, разрешението и рестартируемото захранване.
  • Компонентите на контейнера посочват своите слотове; листата не могат да приемат произволни деца.
  • Марк зрелост честно: планирани блокове, бета предупреждава, GA изисква пълно доказателство.
Разработка · Източници на данни и връзки

Използване на защитени DTO

  1. Изберете съществуващ пунктиран ID като tickets.mine, knowledge.featured или customer.profile.
  2. Завържете само полетата, декларирани от версията DTO. Неизвестни източници не успяват с data_source.unknown.
  3. Преминете вече позволения Портал контекст; никога не приемайте работното пространство/клиент за самоличност от непроверен имот.
  4. Списък граници са закрепени към. 1–100. Нормализиране на странициране, локализация и търсене на стойности.
  5. Ако нов източник е неизбежен, добавете неговата стабилна дефиниция, безопасно картиране, разрешения, празно поведение и превю заедно.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Източниците на данни са само за четене. Мутациите изискват изрично разрешено действие за обслужване, обвързване на работното пространство, CSRF/сесия или валидиране на носителя, неудобство при необходимост и типирана опаковка за грешка.
Разработка · Сигурност

Стой в границите на доверието.

Гранична стойностИзисквано поведение
Работно пространствоСлед това се преоткрива от доверения домакин/път /сесийство, след което огледайте всяко четене и писане преди изпълнение.
HTMLИзползвайте порталния стерилизатор/позволяващия списък. URLs, CSS или сценарий.
ПрегледИзискване на прозорец източник със същия произход, подписана версия канал и nonce. Игнорирайте непоискани съобщения.
ИдентификацияПази тайни извън документите. SCIM е носител-автентичен, без сесийни и работното пространство-обвързана.
ПакетиОтхвърляне на траверсите, абсолютните пътища, връзките/специалните файлове, оразмеряване на архивите, контролния център/подписа и неизвестни разрешения.
ГрешкиВръщане на стабилен код, безопасно съобщение, възможност за повторно използване, възстановяване и корелационно ID; записвайте лични изключения сървър-страна.
ПознанияПрочетете чрез HelpCenterBridge. Никога не автор или дублирайте Helpe Center статии в разширение.
{
  "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"}
  }
}
Разработчик · Пакет и миграция

Инспекция, инсталиране и обновяване на атомно

  1. Сложи го. component.json в корена на ZIP и да запазите всеки път относително.
  2. Инсталацията първо ще се проведе. 500 вписвания и 25 MB извлечени; валидирането на сигурността добавя независими граници.
  3. Проверка на очаквания SHA-256 и пакетния подпис в процеса на освобождаване.
  4. Инсталирайте в версия директория. Никога не мутирайте инсталирана версия на място.
  5. Осигурете имоти миграция за прекъсване на промени схема и да запази неизвестни полета съвместимост.
  6. Отворете компонента в чернова, стартирайте всяко държавно/изгледно/лицейско устройство и го публикувайте чрез управление.
  7. Rollback активира предварително непробиваемия компонент/документ за освобождаване; запазва своите възпроизводими доказателства.
Разработка · Тестове и освобождаване

Докаже разширението на същото освобождаване хашиш

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

Прикрепете база данни/миграция, визуалния, доставчик на лични данни, достъпа до разрешения, ефективността, опашката/крона, пощата/прилепването, архива/резервацията и внедряването на доказателства за същата непроменлива версия. Неизвестните необходими доказателства трябва да не успеят да бъдат освободени.

  • Единица: схема, саниране, DTO форма, условия, миграция и типови неуспехи.
  • Договор: товарене/празна/поръчка/успех, матуритет, слотове, подвързвания и еднопоточни пари.
  • Броузър: клавиатура, фокус, семантика, RTL, увеличение/рефлуб, намалено движение и всяка точка на прекъсване.
  • Охрана: междуработни космически сонди, фалшиви действия, пакетни атаки, превю измами и тайно изтичане.
  • Операции: траен напредък, отпуск/завръщане, стоп/ретри/препоемане, графикен пулс и обратно.
Администратор + Разработчик · Възстановяване

Отстраняване по състояние и идентификационен код на съответствието

ДържаваКакво да правя?
РазрешениеСкритият UI е удобство, а бекендът винаги го налага.
УтвърждаванеОтворете страницата/свързващото поле, коригирайте я и след това преполетете.
КонфликтПрезареди последната ревизия, сравни промените и отново приложи умишлено.
Офлайн / рестартиранПоддържане на проекта, възстановяване на свързаността, повторно се опита чрез действието и проверка на трайно състояние на работа.
Фатален / недостъпенКопирайте ID на съответствието и дата за поддръжка. Никога не поставяйте тайни или личен текст изключение.
Публикуването е неуспешноПроверете предварителното/работното изпълнение, опитайте само повторно опитни етапи, или се върнете към последното здравословно освобождаване.
SCIM 401/403Потвърдете крайната точка/работното пространство, showder signum, активирано състояние и ротация; никога не използвайте бисквитка за сесия на браузъра.
Знанието е остарялоПроверете местоположението/публиката в Центъра за помощ, след това проверете кеш-а за анулиране и чистия локализиран маршрут.

Това ръководство е готово за печат → Запис като PDF за контролирано офлайн копие.