Что это такое?
Это открытый репозиторий, на котором работает docs.github.com — официальная документация GitHub. Здесь лежат и сами материалы, и код сайта, и внести вклад может любой — как из GitHub, так и снаружи.
Это открытый репозиторий, на котором работает docs.github.com — официальная документация GitHub. Здесь лежат и сами материалы, и код сайта, и внести вклад может любой — как из GitHub, так и снаружи.Это работающий сайт документации или его исходники?И то и другое находится в одном репозитории: статьи — это файлы Markdown в каталоге /content (плюс данные вроде reusables), а приложение на TypeScript и Next.js превращает их в сайт docs.github.com.
И то и другое находится в одном репозитории: статьи — это файлы Markdown в каталоге /content (плюс данные вроде reusables), а приложение на TypeScript и Next.js превращает их в сайт docs.github.com.Я заметил опечатку в документации — как её исправить?В README внешних контрибьюторов отправляют к CONTRIBUTING.md, где есть краткая инструкция. Обычно правка — это изменение файла Markdown в каталоге /content или отдельных разделов каталога /data, оформленное как pull request.
В README внешних контрибьюторов отправляют к CONTRIBUTING.md, где есть краткая инструкция. Обычно правка — это изменение файла Markdown в каталоге /content или отдельных разделов каталога /data, оформленное как pull request.Нужна ли какая-то конкретная версия Node, чтобы работать с проектом?Нужна Node.js версии ^24 или ^26 — это указано в поле engines в package.json. В репозитории есть и Dockerfile, если удобнее запустить проект в контейнере, а сайт собирается командой npm run build.
Нужна Node.js версии ^24 или ^26 — это указано в поле engines в package.json. В репозитории есть и Dockerfile, если удобнее запустить проект в контейнере, а сайт собирается командой npm run build.Могу я менять и код сайта, или только статьи?Только содержимое: от внешних контрибьюторов принимаются правки файлов .md в каталоге /content и отдельных разделов каталога /data, например reusables. Файлы инфраструктуры, воркфлоу и код, который собирает сайт, открыты для внешних изменений не будут.
Только содержимое: от внешних контрибьюторов принимаются правки файлов .md в каталоге /content и отдельных разделов каталога /data, например reusables. Файлы инфраструктуры, воркфлоу и код, который собирает сайт, открыты для внешних изменений не будут.Документация распространяется по той же лицензии, что и код?Нет — здесь двойная лицензия: документация и содержимое каталогов assets, content и data распространяются по Creative Commons Attribution 4.0, а код — по MIT License.
Нет — здесь двойная лицензия: документация и содержимое каталогов assets, content и data распространяются по Creative Commons Attribution 4.0, а код — по MIT License.На чём построен сайт?TypeScript на Next.js — скрипт сборки запускает next build --webpack. Поиск работает на Elasticsearch, а в приложение встроена телеметрия через OpenTelemetry.
TypeScript на Next.js — скрипт сборки запускает next build --webpack. Поиск работает на Elasticsearch, а в приложение встроена телеметрия через OpenTelemetry.Если сотрудники GitHub работают в закрытом репозитории, как изменения попадают в публичную документацию?github/docs — публичная часть, а github/docs-internal — закрытый репозиторий для сотрудников; они часто синхронизируются, поэтому изменения содержимого в одном отражаются в другом.
github/docs — публичная часть, а github/docs-internal — закрытый репозиторий для сотрудников; они часто синхронизируются, поэтому изменения содержимого в одном отражаются в другом.Могу ли я переопубликовать документацию GitHub на своём сайте?Статьи распространяются по CC-BY-4.0, которая разрешает повторное использование с указанием авторства, а код — по MIT, так что и то и другое можно использовать, если соблюдать условия этих лицензий.
Статьи распространяются по CC-BY-4.0, которая разрешает повторное использование с указанием авторства, а код — по MIT, так что и то и другое можно использовать, если соблюдать условия этих лицензий.What are similar projects?docusaurus, docs, fumadocs, docz, emoji-cheat-sheet, PandaWiki, NotionNext, docsify
docusaurus, docs, fumadocs, docz, emoji-cheat-sheet, PandaWiki, NotionNext, docsifyWhich topics is it in?docs, opentelemetry, elasticsearch, search, github-actions, github, observability, nextjs, guide, documentation, developers, markdown
docs, opentelemetry, elasticsearch, search, github-actions, github, observability, nextjs, guide, documentation, developers, markdown