Помогайте в создании документации
Документация — начальная точка изучения AMP. Это ресурс, с помощью которого разработчики учатся создавать успешные сайты, истории, рекламу и динамические письма на AMP. За документацию AMP отвечает небольшая команда, которая, однако, несет на себе большую ответственность — поэтому мы так ценим вашу помощь! Волонтеры могут исправлять опечатки, корректировать устаревшую информацию и даже писать документы с нуля. Эта страница расскажет, как принять участие в создании документации.
Благодарим вас за помощь в развитии AMP Project и добро пожаловать в команду!
С чего начать
На amp.dev размещается наша документация, а совместная работа команды AMP ведется на GitHub. Чтобы запустить amp.dev на локальном компьютере, следуйте инструкциям, приведенным в README репозитория amp.dev. Это чрезвычайно важно для обеспечения корректного рендеринга и форматирования ассетов. При этом для исправления простых ошибок (таких как опечатки) файл можно редактировать непосредственно на GitHub.
Присоединяйтесь к группе общественной поддержки в в рабочем пространстве AMP Project в Slack и расскажите, над чем вы работаете!
Есть несколько способов разместить документацию на amp.dev. Здесь представлено краткое описание нескольких из них. Если вы хотите использовать другие способы размещения материалов, свяжитесь с нами, чтобы узнать, являются ли они приемлемыми.
Задачи для новичков
Наша крохотная, но очень трудолюбивая команда неустанно решает большие и малые задачи. Если вы хотите помочь, но не знаете, с чего начать, ознакомьтесь со списком задач и отфильтруйте их по метке good first issues. Это задачи, требующие несложных исправлений, которые позволят вам поближе познакомиться с amp.dev и понять, как устроен процесс работы над документацией.
Редактирование документации
Если вы обнаружили устаревшую, некорректно размещенную или неверную информацию, вы можете ее исправить! Исправления принимаются в виде пулреквестов и задач. Мы будем особенно признательны, если вы создадите задачу и назначите ее себе же, — это упрощает отслеживание задач и помогает избежать дублирования работы.
Написание документации
Нужно руководство или урок, которого нет на amp.dev? Вы можете написать его самостоятельно! Для начала прочитайте статью о типах документации, которую мы принимаем и откройте запрос на создание документации. Как только ваш запрос будет принят, ознакомьтесь с руководством по терминологии AMP и правилами форматирования документации. Информацию о размещении примеров можно получить здесь.
-