В этом репозитории хранится исходный код документации создателя по адресу create.roblox.com/docs.
Примечание . В настоящее время в репозитории имеются руководства, учебные пособия, образовательный контент и справочник по Engine API. Примеры кода скоро появятся.
Если вы не знакомы с процессом внесения вклада в GitHub, см. раздел О запросах на включение и следующее видео.
Если вы обнаружили проблему с документацией и не хотите отправлять запрос на включение, сообщите нам об этом, сообщив об этом на форумах разработчиков Roblox.
Любое дополнение к документации создателя Roblox должно вписываться в единое целое. Другими словами, даже всеобъемлющий, точный, хорошо написанный пост в блоге или технический документ может не найти своего места на веб-сайте.
Вообще говоря, мы ищем контент, который соответствует нашим существующим стандартам и применим к широкому спектру возможностей и вариантов использования. Например, мы предпочитаем такие страницы, как «Создание пользовательских интерфейсов» , а не «Создание спидометра для гоночной игры» . Рассмотрите возможность размещения более специализированных руководств на форуме разработчиков Roblox.
Отправляя запрос на рассмотрение, вы должны согласиться со следующим:
Этот вклад был создан полностью или частично мной, и я имею право представить его в соответствии с условиями лицензий с открытым исходным кодом этого репозитория.
Я понимаю и соглашаюсь, что этот вклад и его запись являются общедоступными, поддерживаются на неопределенный срок и могут распространяться в соответствии с условиями лицензий с открытым исходным кодом этого репозитория.
Насколько мне известно, все предложенные изменения точны.
Для простых изменений, затрагивающих только один файл, используйте веб-редактор GitHub:
Найдите файл в content/en-us/ и нажмите «Редактировать этот файл» .
Нажмите Форкнуть этот репозиторий .
Внесите изменения и нажмите «Зафиксировать изменения...» .
Дайте вашему изменению описательное сообщение о фиксации и нажмите «Предложить изменения» .
Убедитесь, что базовым репозиторием является Roblox/creator-docs , а базовая ветка — main . Убедитесь, что вас устраивают внесенные изменения, и нажмите «Создать запрос на включение» .
Наконец, заполните данные в описании запроса на включение и нажмите «Создать запрос на включение» .
Для более крупных изменений, затрагивающих несколько файлов, мы рекомендуем github.dev, более полнофункциональный текстовый редактор на основе кода Visual Studio, который запускается в вашем браузере:
Форкните репозиторий.
Просматривая свою вилку, нажмите кнопку . ключ для открытия github.dev.
В меню системы управления версиями нажмите ... > Ветвь > Создать ветку... .
Дайте ветке имя и нажмите «Переключиться на ветку» .
Используйте меню Проводника , чтобы найти файлы, которые вы хотите обновить, в content/en-us и внести необходимые изменения.
В меню «Управление версиями» убедитесь, что вас устраивают внесенные изменения.
Добавьте сообщение о фиксации и нажмите «Commit & Push» .
В новой вкладке браузера перейдите по адресу github.com/Roblox/creator-docs.
Нажмите «Сравнить и запросить извлечение» .
Убедитесь, что базовым репозиторием является Roblox/creator-docs , а базовая ветка — main . Головной репозиторий должен быть вашей вилкой и вашей веткой.
Наконец, заполните данные в описании запроса на включение и нажмите «Создать запрос на включение» .
Альтернативно вы можете использовать меню GitHub или GitHub Pull Request в github.dev, чтобы отправить запрос на включение. Документацию по использованию github.dev см. в разделе Кодовые пространства GitHub.
Этот репозиторий чрезвычайно велик, поэтому мы рекомендуем по возможности использовать онлайн-варианты. Однако, если вы уже знакомы с общим рабочим процессом GitHub и хотите использовать автономный текстовый редактор, вот основные шаги для участия в документации:
Настройте Git и Git LFS. Альтернативно установите клиент Git, например GitHub Desktop.
Форкните этот репозиторий.
Клонируйте свою вилку.
Перейдите в корень репозитория.
Создайте новую ветку.
Внесите желаемые изменения.
Зафиксируйте, отправьте вилку и отправьте запрос на включение в main ветку этого репозитория.
Более подробные инструкции см. на сайте CONTRIBUTING.md.
Документация Roblox имеет три основных типа документов:
Концептуальные и основанные на задачах руководства в файлах .md в content/en-us/
Руководства рассказывают вам о функции или рабочем процессе, не давая при этом слишком строгих указаний относительно конечного результата. Они знакомят с концепциями и функциями, а также описывают задачи, которые можно выполнить с помощью различных инструментов и других подходов.
Руководства получают огромную пользу от практических примеров использования из реальной жизни, изображений, фрагментов кода и диаграмм. Большая часть контента, основанного на задачах, должна включать нумерованный список.
Справочная документация по API в файлах .yaml в content/en-us/reference.
API представляют собой полностью справочный контент и должны использовать функциональные описания со ссылками на руководства, где это необходимо. В большей степени, чем другие типы контента, справочный контент должен быть кратким и прямым; Сводки свойств, методов, событий и обратных вызовов не обязательно должны быть полными предложениями.
Учебники в файлах .md в content/en-us/tutorials.
По сравнению с руководствами, основанными на задачах, учебные пособия более самостоятельны и ведут вас от ничего к чему-то . Такая направленность на создание чего-то конкретного означает, что они обычно носят гораздо более предписывающий характер, чем руководства. Учебные пособия часто затрагивают одновременно несколько функций и концепций, демонстрируя связь между инструментами и стратегиями.
Если ваш вклад не вписывается в эти категории или охватывает особенно узкую тему, возможно, он не подходит для документации. Рассмотрите возможность публикации его на форуме разработчиков Roblox.
Постарайтесь ограничить свои изменения одним классом или функцией, чтобы запрос на включение было легче просмотреть. Исправления ошибок и небольшие улучшения имеют более высокую вероятность быстрого одобрения. Большие руководства часто требуют значительных усилий перед публикацией.
Чтобы избежать проблем с форматированием, мы рекомендуем текстовые редакторы, такие как github.dev, которые позволяют предварительно просматривать Markdown во время его написания. Что касается прозы, старайтесь следовать рекомендациям STYLE.md. Для примеров кода используйте Руководство по стилю Lua.
Чтобы просмотреть страницу, полностью отформатированную в соответствии с тем, что мы видим в main ветке, замените весь URL-адрес из content/ и ранее. У файлов с index базового имени это имя должно быть удалено. Например, страница https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md отображается по адресу https://create.roblox.com. /docs/en-us/avatar».
Для прозы в этом проекте используется международная общественная лицензия Creative Commons Attribution 4.0. Полный текст лицензии см. в разделе ЛИЦЕНЗИЯ.
Примеры кода доступны по лицензии MIT. Полный текст лицензии см. в разделе «КОД ЛИЦЕНЗИИ».
Чтобы поддерживать открытое, гостеприимное, разнообразное, инклюзивное и здоровое сообщество, этот проект применяет адаптированную версию Соглашения участников. Для получения дополнительной информации см. CODE_OF_CONDUCT.md.
