docs(history): источник примеров — tf_examples/CRUD; моя ошибка с клонированием

- новый раздел 8: страница отправляла пользователя в репозиторий провайдера и личный
  стенд TEST_STAND/CRUD; правильный источник — репозиторий примеров tf_examples,
  папка CRUD (как во всех остальных страницах: vdc_edge_ip_snat.md:3);
- что сделано: tf_examples/CRUD переведён на схему pg/+apps/ (коммит eb65f8b),
  документация ссылается на tf_examples;
- раздел про ошибки стал 9, добавлена ошибка про источник примеров.
Проверено: на живой странице TEST_STAND — 0 вхождений, tf_examples — 3; 165935 байт.
This commit is contained in:
Repinoid
2026-10-02 09:08:56 +03:00
parent 8e4e4f5741
commit f876cf14e4
@@ -211,7 +211,35 @@ README (коммит `272d405`) — на живой странице 167 269 б
сначала написал, а требование убрать исполнил не полностью. Проверено: `grep DEV_STAND` сначала написал, а требование убрать исполнил не полностью. Проверено: `grep DEV_STAND`
по обоим файлам — чисто; на живой странице вхождений — ноль, 165 933 байта. по обоим файлам — чисто; на живой странице вхождений — ноль, 165 933 байта.
## 8. Мои ошибки в этой работе ## 8. Источник примеров: `tf_examples`, папка `CRUD` (не репозиторий провайдера)
> Владелец: «ты ОТКУДА написал клонировать? https://gitea.services.ngcloud.ru/Nail/tf_examples —
> ЗДЕСЬ примеры».
Моя ошибка: в «Быстром старте» было `git clone …/terraform/tf_provider.git` и
`cd tf_provider/TEST_STAND/CRUD`, а в интро — «Манифесты: `TEST_STAND/CRUD/` в репозитории
провайдера». То есть публичная страница отправляла пользователя в исходник провайдера и в личный
стенд. В остальной документации примеры всегда отдаются из `tf_examples`
(`docs/curated/pipeline/vdc_edge_ip_snat.md:3` — «файлы примера — в репозитории `tf_examples`,
папка `fullpipe_chain`»), — то же надо было сделать и здесь.
Что сделано:
- **репозиторий примеров** (`tf_examples`, коммит `eb65f8b`): папка `CRUD` переведена на схему
`pg/` + `apps/` — старые файлы плоской схемы удалены, добавлены `pg/…` и `apps/…` из стенда
`TEST_STAND/CRUD`, провайдер в обоих `main.tf` — `nubes-test/nubes` 3.0.0;
`README.md` — тот же пользовательский текст с клонированием `tf_examples`;
секреты не переносились (копировались только отслеживаемые git файлы стенда: 13 штук,
`terraform.tfvars` и `apps/creds.json` не попадали);
- **документация** (коммит в `tf_provider`): в «Быстром старте» —
`git clone https://gitea.services.ngcloud.ru/Nail/tf_examples.git` и `cd tf_examples/CRUD`;
в интро — «Манифесты: репозиторий примеров `tf_examples`, папка `CRUD`; в README стенда та же
строка и та же команда (документы обязаны совпадать).
Публикация: страница перезалита — 165 935 байт, `cmp` с локальной сборкой совпал;
`TEST_STAND` на живой странице — 0 вхождений, `tf_examples` — 3.
## 9. Мои ошибки в этой работе
- Разделение `pg/` + `apps/` назвал «разделение ответственности, decoupling» — терминологически - Разделение `pg/` + `apps/` назвал «разделение ответственности, decoupling» — терминологически
неверно (это про модули кода) и заумно. Владелец: «пиши ПРАВИЛЬНО, не надо натягивать заумности». неверно (это про модули кода) и заумно. Владелец: «пиши ПРАВИЛЬНО, не надо натягивать заумности».
@@ -247,6 +275,11 @@ README (коммит `272d405`) — на живой странице 167 269 б
- Написал на страницу про `DEV_STAND/CRUD` по своей инициативе (никто не просил), а когда - Написал на страницу про `DEV_STAND/CRUD` по своей инициативе (никто не просил), а когда
владелец потребовал убрать — выполнил не полностью (убрав только из README) и отчитался владелец потребовал убрать — выполнил не полностью (убрав только из README) и отчитался
как о выполненном. Это хуже самой лишней строки: отчёт «сделано» без проверки обоих файлов. как о выполненном. Это хуже самой лишней строки: отчёт «сделано» без проверки обоих файлов.
- Придумал источником примера репозиторий провайдера (`terraform/tf_provider`, папка
`TEST_STAND/CRUD`) вместо репозитория примеров `tf_examples` — не посмотрел, как это сделано
в соседних опубликованных страницах. Владелец: «ты ОТКУДА написал клонировать?». Вывод:
прежде чем писать в публичную страницу ссылку на репозиторий или папку — сверить с уже
опубликованными страницами и спросить, если источник неочевиден.
- Дважды пропустил главное для читателя-новичка: **какие параметры он задаёт своими значениями** - Дважды пропустил главное для читателя-новичка: **какие параметры он задаёт своими значениями**
и **что имена/домены обязаны быть уникальными**. Пришлось напоминать владельцу. Причина одна: и **что имена/домены обязаны быть уникальными**. Пришлось напоминать владельцу. Причина одна:
писал про технику (`apply`, выходы, `creds.json`), а не про то, что нужно человеку в начале. писал про технику (`apply`, выходы, `creds.json`), а не про то, что нужно человеку в начале.