terraform/tf_provider
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: describe stand-agnostic docs pipeline

Browse Source
This commit is contained in:
“Naeel”
2026-09-03 12:05:21 +03:00
parent 8d5bbd368d
commit 6bf514e03a
1 changed files with 10 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HISTORY/2026-09-03_docs_upload_pipeline_verified.md
+10 -21
View File
@@ -12,12 +12,6 @@
generated/<stand>/docs/ generated/<stand>/docs/
``` ```
Для DEV:
```text
generated/dev/docs/
```
Ручной каталог `docs/` не используется как основной `docs_dir`. Скрипт `04_build_and_publish_docs.sh` перед сборкой копирует в сгенерированный каталог только общие материалы: Ручной каталог `docs/` не используется как основной `docs_dir`. Скрипт `04_build_and_publish_docs.sh` перед сборкой копирует в сгенерированный каталог только общие материалы:
```text ```text
@@ -69,17 +63,10 @@ site/
terraform-registry terraform-registry
``` ```
Публикация выполняется без версии. Для DEV целевой S3 prefix: Публикация выполняется без версии. Для любого стенда целевой S3 prefix:
```text ```text
terraform-registry/docs/nubes-dev/nubes/ terraform-registry/docs/<namespace>/nubes/
```
Для остальных стендов:
```text
terraform-registry/docs/nubes-test/nubes/
terraform-registry/docs/nubes/nubes/
``` ```
Актуальный `scripts/publish-docs.sh` использует: Актуальный `scripts/publish-docs.sh` использует:
@@ -123,22 +110,24 @@ S3 upload и обновление зеркала — два отдельных
/var/www/tf-docs/ /var/www/tf-docs/
``` ```
Сервис `tf_docs` проксирует публичный домен на ВМ. Для DEV итоговый путь: Сервис `tf_docs` проксирует публичный домен на ВМ. Для любого стенда итоговый путь:
```text ```text
/var/www/tf-docs/nubes-dev/ /var/www/tf-docs/<namespace>/
``` ```
Итоговый URL DEV: Итоговый URL любого стенда:
```text ```text
https://tf-docs.nodejsk8s.dev.nubes.ru/nubes-dev/ https://tf-docs.nodejsk8s.dev.nubes.ru/<namespace>/
``` ```
Путь с версией не используется: Например, для DEV `<namespace>` равен `nubes-dev`, но это только значение профиля, а не отдельная логика pipeline.
Путь с версией не используется для любого стенда:
```text ```text
https://tf-docs.nodejsk8s.dev.nubes.ru/nubes-dev/2.0.0/ https://tf-docs.nodejsk8s.dev.nubes.ru/<namespace>/<version>/
``` ```
не является корректным URL документации. не является корректным URL документации.