diff options
author | alexv-smirnov <81806911+alexv-smirnov@users.noreply.github.com> | 2022-06-27 14:25:50 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-27 14:25:50 +0300 |
commit | 8e68fd9c42adc737b7e5357a1a09cd8d955c2528 (patch) | |
tree | 34bd2c41ce8214bb54bff5c28e67cbfda378b269 | |
parent | 3b03d58d5e6659bf06cb25e99efac23b34ec6685 (diff) | |
parent | b61f4407b3004e137889c2534aa4f52b219c4f9b (diff) | |
download | ydb-8e68fd9c42adc737b7e5357a1a09cd8d955c2528.tar.gz |
Merge pull request #77 from zinal/fix_ydbDocRoot
Updated the YDB docs repository location to the correct one
9 files changed, 10 insertions, 8 deletions
diff --git a/ydb/docs/en/core/how_to_edit_docs/_includes/build/local_oss.md b/ydb/docs/en/core/how_to_edit_docs/_includes/build/local_oss.md index d9af4985fd..3820ddd5ea 100644 --- a/ydb/docs/en/core/how_to_edit_docs/_includes/build/local_oss.md +++ b/ydb/docs/en/core/how_to_edit_docs/_includes/build/local_oss.md @@ -12,7 +12,7 @@ yfm -i <source_dir> -o <output_dir> --allowHTML Where: -- `source_dir` is the directory where the contents of [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs) is cloned. +- `source_dir` is the directory where the contents of [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}) is cloned. - `output_dir` is the output directory for HTML files. Building the documentation takes a few seconds and there should be no errors logged to the stdout. diff --git a/ydb/docs/en/core/how_to_edit_docs/_includes/content.md b/ydb/docs/en/core/how_to_edit_docs/_includes/content.md index dfcf7b6284..3570142dbb 100644 --- a/ydb/docs/en/core/how_to_edit_docs/_includes/content.md +++ b/ydb/docs/en/core/how_to_edit_docs/_includes/content.md @@ -276,7 +276,7 @@ Text inside the square brackets displayed when rendering documentation should be There are situations when the URL of a resource has its own value and should be displayed in the documentation, for example, when publishing links to a repository on Github. In this case, it must be duplicated inside both square and regular brackets, since YFM, unlike standard Markdown, does not automatically recognize URLs in text: ```md -{{ ydb-short-name }} repository on Github: [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs) +{{ ydb-short-name }} repository on Github: [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}) ``` ## Images {#pictures} diff --git a/ydb/docs/en/core/how_to_edit_docs/_includes/contribute.md b/ydb/docs/en/core/how_to_edit_docs/_includes/contribute.md index 8a19c28e9f..19070858e4 100644 --- a/ydb/docs/en/core/how_to_edit_docs/_includes/contribute.md +++ b/ydb/docs/en/core/how_to_edit_docs/_includes/contribute.md @@ -1,6 +1,6 @@ # How to participate in the development of documentation -The source code of the {{ ydb-short-name }} documentation is open and published at [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs). +The source code of the {{ ydb-short-name }} documentation is open and published at [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}). The {{ ydb-short-name }} team accepts requests for edits and updates to the {{ ydb-short-name }} documentation, which anyone can offer through [Pull Requests on github.com](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request). diff --git a/ydb/docs/en/core/how_to_edit_docs/_includes/index/intro.md b/ydb/docs/en/core/how_to_edit_docs/_includes/index/intro.md index 13385e4398..83da0cc26f 100644 --- a/ydb/docs/en/core/how_to_edit_docs/_includes/index/intro.md +++ b/ydb/docs/en/core/how_to_edit_docs/_includes/index/intro.md @@ -2,5 +2,5 @@ ## Introduction -The [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs) repository contains the open source code of the {{ ydb-short-name }} documentation in Russian and English. Based on it, an OpenSource version of the {{ ydb-short-name }} documentation is built and published at [http://ydb.tech](http://ydb.tech). It is also used to create customized {{ ydb-short-name }} documentation versions for enterprise environments and cloud services. +The [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}) repository contains the open source code of the {{ ydb-short-name }} documentation in Russian and English. Based on it, an OpenSource version of the {{ ydb-short-name }} documentation is built and published at [http://ydb.tech](http://ydb.tech). It is also used to create customized {{ ydb-short-name }} documentation versions for enterprise environments and cloud services. diff --git a/ydb/docs/presets.yaml b/ydb/docs/presets.yaml index b62c67fa50..9f8ee9b089 100644 --- a/ydb/docs/presets.yaml +++ b/ydb/docs/presets.yaml @@ -31,4 +31,6 @@ default: k8s: Kubernetes oss: true + ydb-doc-repo: https://github.com/ydb-platform/ydb/tree/main/ydb/docs + corporate-paste: https://www.paste.example.com diff --git a/ydb/docs/ru/core/how_to_edit_docs/_includes/build/local_oss.md b/ydb/docs/ru/core/how_to_edit_docs/_includes/build/local_oss.md index 6f7e0c8b47..473d6cddac 100644 --- a/ydb/docs/ru/core/how_to_edit_docs/_includes/build/local_oss.md +++ b/ydb/docs/ru/core/how_to_edit_docs/_includes/build/local_oss.md @@ -11,7 +11,7 @@ yfm -i <source_dir> -o <output_dir> --allowHTML ``` Где: -- `source_dir` - директория, куда склонировано содержимое [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs) +- `source_dir` - директория, куда склонировано содержимое [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}) - `output_dir` - директория, куда будет выполнена генерация HTML-файлов Сборка занимает несколько секунд, и не должна выводить сообщений об ошибках в лог (stdout). diff --git a/ydb/docs/ru/core/how_to_edit_docs/_includes/content.md b/ydb/docs/ru/core/how_to_edit_docs/_includes/content.md index 88a63c0d98..448c788f08 100644 --- a/ydb/docs/ru/core/how_to_edit_docs/_includes/content.md +++ b/ydb/docs/ru/core/how_to_edit_docs/_includes/content.md @@ -267,7 +267,7 @@ OpenSource документация по {{ ydb-short-name }} поддержив Существуют ситуации, когда URL ресурса имеет самостоятельную ценность, и должен быть отображен в документации, например, в случае публикации ссылок на репозиторий в github. В таких случаях его необходимо дублировать как внутри квадратных скобок, так и внутри обычных, так как YFM, в отличие от стандартного Markdown, не распознает автоматом URL в тексте: ``` md -Github репозиторий {{ ydb-short-name }}: [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs) +Github репозиторий {{ ydb-short-name }}: [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}) ``` ## Картинки {#pictures} diff --git a/ydb/docs/ru/core/how_to_edit_docs/_includes/contribute.md b/ydb/docs/ru/core/how_to_edit_docs/_includes/contribute.md index fd46b79d60..71c4de87fd 100644 --- a/ydb/docs/ru/core/how_to_edit_docs/_includes/contribute.md +++ b/ydb/docs/ru/core/how_to_edit_docs/_includes/contribute.md @@ -1,6 +1,6 @@ # Как участвовать в разработке документации -Исходный код документации {{ ydb-short-name }} открыт и опубликован на [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs). +Исходный код документации {{ ydb-short-name }} открыт и опубликован на [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}). Команда {{ ydb-short-name }} принимает запросы на изменения и дополнения в документации {{ ydb-short-name }}, который может предложить каждый желающий через механизм [Pull Requests на github.com](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request). diff --git a/ydb/docs/ru/core/how_to_edit_docs/_includes/index/intro.md b/ydb/docs/ru/core/how_to_edit_docs/_includes/index/intro.md index 2adec431ab..b78bf51206 100644 --- a/ydb/docs/ru/core/how_to_edit_docs/_includes/index/intro.md +++ b/ydb/docs/ru/core/how_to_edit_docs/_includes/index/intro.md @@ -2,4 +2,4 @@ ## Введение -В репозитории [https://github.com/ydb-platform/ydb/tree/master/docs](https://github.com/ydb-platform/ydb/tree/master/docs) размещен публично доступный исходный код документации по {{ ydb-short-name }} на русском и английском языках. На его основании собирается и публикуется документация по OpenSource версии {{ ydb-short-name }} на сайте [http://ydb.tech](http://ydb.tech), а также он используется для создания кастомизированной документации по {{ ydb-short-name }} для enterprise-окружений и облачных сервисов. +В репозитории [{{ ydb-doc-repo }}]({{ ydb-doc-repo }}) размещен публично доступный исходный код документации по {{ ydb-short-name }} на русском и английском языках. На его основании собирается и публикуется документация по OpenSource версии {{ ydb-short-name }} на сайте [http://ydb.tech](http://ydb.tech), а также он используется для создания кастомизированной документации по {{ ydb-short-name }} для enterprise-окружений и облачных сервисов. |