WP Engine — крупнейший в мире провайдер managed WordPress-хостинга. 8% всех людей в интернете ежедневно посещают сайт на WP Engine. При таком масштабе качественная документация критична. Но у команды WP Engine была проблема: на поддержку кодовой базы документации уходило больше времени, чем на написание самой документации. Что-то должно было измениться.
Starlight — полнофункциональная, экологичная и доступная по умолчанию тема для документации на базе Astro. WP Engine выбрала Starlight для нового сайта документации Atlas — hosting-решения WP Engine для headless WordPress-приложений. Результаты говорят сами за себя.
Starlight позволила команде Atlas работать в два раза быстрее и снизила затраты на разработку более чем на 50%. Сегодня команда тратит 95% времени на контент и почти ноль — на поддержку кода и конфигурацию.
Проблемы
У прежнего сайта документации WP Engine было три основные проблемы.
Во-первых, документация хранилась в отдельном GitHub-репозитории с MDX, а Next.js-оболочка, которая их подключала, жила отдельно. Изменения в MDX не запускали автоматическую пересборку сайта или превью. Обходной путь — отдельное dev-окружение для проверки изменений перед деплоем. Но это означало дополнительное управление Git-ветками.
Во-вторых, визуальные и функциональные изменения сайта документации занимали много времени. К тому же прежний сайт выглядел не лучшим образом и не давал всех нужных пользователям возможностей.
В-третьих, из-за связки MDX и React вносить правки могли только разработчики. Это отсекало важных контрибьюторов — PM и специалистов поддержки, которые не могли править документацию сами.
Требования
Чтобы решить три главные проблемы WP Engine, нужно было решение с низким порогом входа, которое упростило бы жизнь и мейнтейнерам документации, и контрибьюторам. Нужен был инструмент, убирающий лишнее время на frontend-разработку как барьер для хорошей документации.
К счастью для команды, Jeff Everhart, developer advocate в WP Engine, знал подходящее решение.
Решение и внедрение
В августе 2023 года Astro запустила Starlight на Product Hunt — open-source веб-фреймворк для современных сайтов документации. Jeff знал Astro, но пока не находил повода использовать его. Starlight дала идеальный повод.
Starlight идеально подошла WP Engine, потому что включала все повторяющиеся элементы, которые им были нужны. Навигация, поиск, i18n, подсветка синтаксиса, тёмная тема и многое другое — из коробки. При этом каждый элемент выглядел отлично! Было много опций кастомизации, включая простую настройку логотипов для светлой и тёмной темы. И всё это — почти без кастомного CSS. WP Engine могла сосредоточиться на написании контента, а не тратить несколько спринтов на пользовательские интерфейсы.
Фреймворк Starlight — полностью статическое решение, отдающее только HTML. Это сократило время онбординга и для мейнтейнеров, и для контрибьюторов: обе стороны не обязаны были учить JavaScript или React, чтобы что-то опубликовать.
Миграция с прежнего решения на Astro прошла практически безболезненно. Команде Jeff достаточно было скопировать существующую папку из ~100 MDX-файлов в шаблон Starlight — и сайт уже работал. Всё управлялось через config и простую CSS-таблицу стилей. Документационной команде понадобилось минимум обучения, потому что Starlight очень прост в использовании.
Результаты
С прежним решением WP Engine команда тратила на управление сайтом документации больше времени, чем на работу с контентом. Если соотношение «писать контент : поддерживать сайт» было 30:70, теперь оно ближе к 95:5. Starlight от Astro снизила трение настолько, что PM в команде WP Engine сказал о новом фреймворке следующее:
«Опыт для наших клиентов стал намного лучше, и при этом я сэкономил СТОЛЬКО ЧАСОВ, которые иначе ушли бы на тщательное тестирование и доводку новых страниц документации Atlas».
Операции с контентом в WP Engine стали более чем в 2 раза быстрее за счёт убранных Git-процедур и ручных шагов тестирования. Процесс стал проще — и люди охотнее вносят вклад. Starlight также снизила затраты на разработку более чем на 50%, потому что дала все нужные UI-элементы из коробки. Поддерживать решение в актуальном состоянии тоже значительно проще. Раньше приходилось управлять множеством зависимостей для разных UI-элементов, например выпадающих списков. В итоге было гораздо больше тикетов Dependabot. Со Starlight достаточно обновлять один фреймворк.
