Сценарии быстрого старта в веб-консоли#

Следуйте рекомендациям раздела при создании руководства по быстрому старту, чтобы обеспечить единообразный пользовательский интерфейс при всех быстрых стартах. Сценарий быстрого старта — это пошаговое руководство с пользовательскими задачами. В OKD console доступ к быстрому старту доступен в меню «Help». Сценарии быстрого старта особенно полезны для ориентации в приложении, операторе или другом продукте.

Определение быстрого старта#

Быстрый старт в основном состоит из задач и шагов. Каждая задача состоит из нескольких шагов, а каждое быстрое начало состоит из нескольких задач. Например:

  • Задача 1;

    • Шаг 1;

    • Шаг 2;

    • Шаг 3;

  • Задача 2;

    • Шаг 1;

    • Шаг 2;

    • Шаг 3;

  • Задача 3;

    • Шаг 1;

    • Шаг 2;

    • Шаг 3.

Быстрый старт пользовательского рабочего процесса#

При взаимодействии с существующим кратким руководством по началу работы, ожидаемый рабочий процесс выглядит следующим образом:

  1. В роли Administrator или Developer нажмите значок Help icon и выберите Quick Starts.

  2. Нажмите на карточку быстрого старта.

  3. В появившейся панели нажмите Start.

  4. Выполните инструкции на экране, затем нажмите Next.

  5. В появившемся модуле Check your work ответьте на вопрос, чтобы подтвердить, что задача успешно выполнена:

    • Нажмите Yes и Next, чтобы перейти к следующей задаче;

    • При выборе No повторите инструкции по задаче и еще раз проверьте свою работу.

  6. Повторите шаги с 1 по 6, описанные выше, чтобы выполнить оставшиеся задачи быстрого старта.

  7. После выполнения финальной задачи нажмите Close, чтобы закрыть быстрый старт.

Компоненты быстрого старта#

Быстрый старт состоит из следующих разделов:

  • Card: вкладка каталога, содержащая основную информацию о быстром старте, включая заголовок, описание, временные рамки и статус завершения;

  • Introdaction: краткий обзор цели и задач быстрого старта;

  • Task headings: заголовки с гиперссылками для каждой задачи в быстром старте;

  • Check your work module: модуль, позволяющий пользователю подтвердить, что он успешно выполнил задачу, прежде чем переходить к следующей задаче в быстром старте;

  • Hints: анимация, помогающая пользователям идентифицировать определенные области продукта;

  • Buttons:

    • Кнопки Next и Back: кнопки для навигации по шагам и модулям каждой задачи быстрого старта;

    • Final screen buttons: кнопки для закрытия быстрого старта, возврата к предыдущим задачам в рамках быстрого старта и просмотра всех быстрых стартов.

Основная область содержимого быстрого старта включает в себя следующие разделы:

  • Card copy (копия вкладки каталога);

  • Introduction (введение);

  • Task steps (шаги задачи);

  • Modals and in-app messaging (Модульные окна и обмен сообщениями);

  • Check your work module (Проверка рабочего модуля).

Содействие быстрому старту#

OKD console представляет пользовательский ресурс для быстрого старта, который определяется объектом ConsoleQuickStart. Операторы и администраторы могут использовать этот ресурс для быстрого старта кластера.

Предварительные условия#

Предварительные условия для быстрого старта:

  • Получены права администратора кластера.

Процедура быстрого старта#

  1. Чтобы создать новый быстрый старт, запустите:

    kubectl get -o yaml consolequickstart spring-with-s2i > my-quick-start.yaml

  2. Создайте файл:

    kubectl create -f my-quick-start.yaml

  3. Обновите файл YAML, используя рекомендации, изложенные в этой документации.

  4. Сохраните изменения.

Просмотр документации API быстрого старта#

Процедура#

Чтобы просмотреть документацию по API быстрого старта, запустите:

kubectl explain consolequickstarts

Запустите kubectl explain -h для получения дополнительной информации об использовании kubectl explain.