docs(history): ревизия README «глазами юзера» + перезаливка страницы + своя ошибка

- в таблицу правок добавлен коммит 272d405 (клонирование, шаг 4 с адресами,
  диагностика, суффикс nodejsk8s);
- в раздел про ручную публикацию: страница перезаливалась дважды, после правок
  на живой странице 167269 байт, cmp с локальной сборкой совпал;
- в «Мои ошибки»: склейка двух строк таблицы «Файлы» из-за замены строки вместе
  с переводом строки (обнаружено и исправлено); отсутствие в README входа
  (клонирование) и выхода (адреса приложений).
Проверено: все четыре вставки на месте, структура файла цела.
This commit is contained in:
Repinoid
2026-10-02 08:34:18 +03:00
parent 272d4051f4
commit 02114bf195
@@ -22,6 +22,7 @@
| `5674b86`, `b8f5238` | Добавлен раздел «Справка: выходные параметры `pg/`»: состав шести выходов, вид JSON (`{sensitive, type, value}` — поэтому в `apps/locals.tf` берётся `.value`), таблица «выход → переменная окружения» для Flask / Node.js / Lucee. Сначала раздел вставлен в шаг 2, затем по команде владельца перенесён в конец файла (в шаге 2 он мешал последовательности трёх шагов) | | `5674b86`, `b8f5238` | Добавлен раздел «Справка: выходные параметры `pg/`»: состав шести выходов, вид JSON (`{sensitive, type, value}` — поэтому в `apps/locals.tf` берётся `.value`), таблица «выход → переменная окружения» для Flask / Node.js / Lucee. Сначала раздел вставлен в шаг 2, затем по команде владельца перенесён в конец файла (в шаге 2 он мешал последовательности трёх шагов) |
| `7b63f12` | По замечанию владельца «я не вижу описания какие параметры юзер должен СВОИ задавать… и что имя домена должно быть УНИКАЛЬНО? и имя инстанса в пределах стенда?» добавлен раздел «Что пользователь задаёт сам»: обязательные значения (`api_token`, `realm`, `s3_name`), имена с правилами уникальности (кластер и приложения — в пределах стенда, юзер/база — в пределах кластера, домены — в облаке) с объяснением через `adopt_existing_on_create` (`provider/internal/resources_core/crud.go:171`, `provider/internal/core/refsvc_find.go:47`), и список того, что можно не задавать. Из шагов 1 и 3 убраны дублирующие таблицы | | `7b63f12` | По замечанию владельца «я не вижу описания какие параметры юзер должен СВОИ задавать… и что имя домена должно быть УНИКАЛЬНО? и имя инстанса в пределах стенда?» добавлен раздел «Что пользователь задаёт сам»: обязательные значения (`api_token`, `realm`, `s3_name`), имена с правилами уникальности (кластер и приложения — в пределах стенда, юзер/база — в пределах кластера, домены — в облаке) с объяснением через `adopt_existing_on_create` (`provider/internal/resources_core/crud.go:171`, `provider/internal/core/refsvc_find.go:47`), и список того, что можно не задавать. Из шагов 1 и 3 убраны дублирующие таблицы |
| `39849bf` | Тот же раздел продублирован на странице сайта: README стенда и `docs/curated/crud/three_apps.md` обязаны описывать одно и то же. Плюс выровнены отступы в общем блоке `cp terraform.tfvars.example` | | `39849bf` | Тот же раздел продублирован на странице сайта: README стенда и `docs/curated/crud/three_apps.md` обязаны описывать одно и то же. Плюс выровнены отступы в общем блоке `cp terraform.tfvars.example` |
| `272d405` | Ревизия README «глазами юзера» по требованию владельца («где про клонирование??»). Добавлено: раздел «Где взять манифесты» (клонирование `terraform/tf_provider`, `cd TEST_STAND/CRUD`, `terraform version`, откуда берётся провайдер — `nubes-test/nubes` 3.0.0), шаг 4 «Проверить» с реальными адресами (`lucee-crud.luceek8s.dev.nubes.ru`, `flask-crud.pythonk8s.dev.nubes.ru`, `nodejs-crud.nodejsk8s.dev.nubes.ru` — взято из `apps/terraform.tfstate`), раздел «Если `apply` упал», в «Файлы» — `terraform.tfvars.example`. Заглушка `<суффикс>` заменена на фактический суффикс `nodejsk8s`; раздел «Запуск» стал «четыре шага». То же продублировано на странице сайта |
Все факты сверены чтением файлов: `pg/outputs.tf`, `pg/main.tf`, `pg/postgres.tf`, Все факты сверены чтением файлов: `pg/outputs.tf`, `pg/main.tf`, `pg/postgres.tf`,
`pg/postgres_user_db.tf`, `apps/locals.tf`, `apps/lucee.tf`, `apps/flask.tf`, `apps/nodejs.tf`. `pg/postgres_user_db.tf`, `apps/locals.tf`, `apps/lucee.tf`, `apps/flask.tf`, `apps/nodejs.tf`.
@@ -109,7 +110,6 @@
> эта ручная заливка — временная, для демонстрации коллегам». > эта ручная заливка — временная, для демонстрации коллегам».
Сделано **минимально** — одна страница, без полной пересборки сайта: Сделано **минимально** — одна страница, без полной пересборки сайта:
1. Сборка test-стенда без публикации: `S3CFG_REGISTRY=/nonexistent-s3cfg-disable-publish 1. Сборка test-стенда без публикации: `S3CFG_REGISTRY=/nonexistent-s3cfg-disable-publish
./TOOLS/scripts/04_build_and_publish_docs.sh --profile TOOLS/config/test`. ./TOOLS/scripts/04_build_and_publish_docs.sh --profile TOOLS/config/test`.
Сборка проходит (mkdocs 1.6.1 системный, 9 с), затем скрипт сам падает на Сборка проходит (mkdocs 1.6.1 системный, 9 с), затем скрипт сам падает на
@@ -127,6 +127,9 @@
— HTTP 200, 163 789 байт, `cmp` с локальной сборкой — **совпадает байт в байт**; — HTTP 200, 163 789 байт, `cmp` с локальной сборкой — **совпадает байт в байт**;
на странице `version` = 3.0.0, вхождений `5.0.5` — ноль. на странице `version` = 3.0.0, вхождений `5.0.5` — ноль.
💡 Страница перезаливалась дважды: сразу после первой публикации и повторно после правок
README (коммит `272d405`) — на живой странице 167 269 байт, `cmp` с локальной сборкой совпал.
⚠️ Ограничение: остальные страницы стенда не тронуты, их меню старое — **ссылки на ⚠️ Ограничение: остальные страницы стенда не тронуты, их меню старое — **ссылки на
новую страницу в меню нет**, она доступна только по прямому адресу. Чтобы она появилась новую страницу в меню нет**, она доступна только по прямому адресу. Чтобы она появилась
в разделе «Проверенные примеры» в меню, нужна полная пересборка и публикация стенда — это в разделе «Проверенные примеры» в меню, нужна полная пересборка и публикация стенда — это
@@ -148,6 +151,13 @@
Владелец поправил: в `*_domain` задаётся **имя**, а не домен — полный домен строит платформа Владелец поправил: в `*_domain` задаётся **имя**, а не домен — полный домен строит платформа
(`flask-crud` → `flask-crud.pythonk8s.dev.nubes.ru`), и вот эти полные имена уникальны. (`flask-crud` → `flask-crud.pythonk8s.dev.nubes.ru`), и вот эти полные имена уникальны.
Исправлено в README стенда и на странице сайта. Исправлено в README стенда и на странице сайта.
- При правке таблицы «Файлы» сам сломал формат: заменил строку вместе с переводом строки,
из-за чего строки `pg/main.tf` и `pg/postgres.tf` склеились в одну (`… базы || … кластер`).
Обнаружено сразу при проверке той же правки, восстановлено. Вывод: перед заменой строк
таблицы проверять результат целиком, а не только «замена применилась».
- В README изначально не было **входа в пример** (как получить файлы — клонирование) и
**выхода** (куда зайти после `apply`). Владелец: «где про клонирование???». Ошибка того же
рода, что ниже: документировал устройство, а не путь пользователя от нуля до результата.
- Дважды пропустил главное для читателя-новичка: **какие параметры он задаёт своими значениями** - Дважды пропустил главное для читателя-новичка: **какие параметры он задаёт своими значениями**
и **что имена/домены обязаны быть уникальными**. Пришлось напоминать владельцу. Причина одна: и **что имена/домены обязаны быть уникальными**. Пришлось напоминать владельцу. Причина одна:
писал про технику (`apply`, выходы, `creds.json`), а не про то, что нужно человеку в начале. писал про технику (`apply`, выходы, `creds.json`), а не про то, что нужно человеку в начале.