-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
749c30e
commit 36e68c4
Showing
6 changed files
with
63 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,23 @@ | ||
# Функциональные возможности | ||
# Функциональные возможности | ||
|
||
## Работа в парадигме Docs as code | ||
|
||
Документация разрабатывается с помощью привычных инструментов разработчика. Используйте расширенный диалект Markdown и отслеживайте изменения с помощью системы контроля версий. | ||
|
||
## Предварительный просмотр изменений | ||
|
||
Проверяйте изменения на тестовых хостах в каждом пулл-реквесте. | ||
|
||
Поддерживается в репозиториях GitHub и GitLab. | ||
|
||
## Интеграция и автоматизация | ||
|
||
Diplodoc поддерживает интеграцию с СI/CD системами – требуется включение [Builder](tools/docs/index.md) для срабатывания по триггерам обновления документации в репозитории. | ||
|
||
Как для С++ или Java проектов используются специальные компиляторы в пайплайнах, так для документации эта задача выполняется Builder'ом. Он создает готовые документы (артефакты), которые потом можно автоматически разместить на внутренних или внешних ресурсах для пользователей. | ||
|
||
### Публикация на собственном домене или на diplodoc.com | ||
|
||
Если ваш проект использует Github как систему контроля версий и место хранения исходного кода вашей документации, Diplodoc позволит создать полностью интегрированный пайплайн работы, покрывающий все шаги от внесения изменений в исходные тексты до построения проекта с помощью Github actions и интеграции с Elastic Search. | ||
|
||
[Свяжитесь с нами](https://diplodoc.com/#contact), чтобы обсудить детали вашей конфигурации и возможные варианты решения. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Публикация на GitHub Pages | ||
|
||
1. В GitHub в репозитории вашего документа перейдите на вкладку **Settings** и в меню слева выберите **Pages**. | ||
|
||
1. В разделе **Build and deployment** в выпадающем списке выберите **GitHub Actions** и в появившемся блоке **Static HTML** нажмите кнопку **Configure**. Откроется окно редактирования экшна. | ||
|
||
1. В блоке `jobs` после строки `uses: actions/configure-pages@v5` добавьте код | ||
|
||
```yaml | ||
- name: Build docs | ||
uses: diplodoc-platform/docs-build-action@v3 | ||
with: | ||
src-root: './docs' | ||
build-root: './docs-html' | ||
``` | ||
1. Вверху справа нажмите **Commit changes...**, укажите имя коммита в поле **Commit message** и нажмите кнопку **Commit changes**. | ||
1. Перейдите на вкладку **Actions**. Вверху списка будет ваш последний коммит. | ||
1. Нажмите на название коммита. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью **deploy**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters