docs(history): порядок разделов, чистка недоступного пользователю, мои ошибки
- новый раздел 6: «Быстрый старт» первым, описание ниже; убраны раздел про instanceOperations и ссылка на HISTORY/…; убраны ссылки на внутренний код (crud.go:171, refsvc_find.go:47), на строки apps/locals.tf:45,57,68 и абзац про прежние имена; со страницы убрано «смотрите журнал операции»; - раздел про ошибки стал 7; добавлены три ошибки: нерабочий блок диагностики перенёс дальше, не проверив пригодность для читателя; много текста вперёд без согласования порядка. Проверено: разделы 1-7 на месте, факты (162257 байт, нулевые вхождения) — из проверки живой страницы.
This commit is contained in:
@@ -138,7 +138,30 @@ README (коммит `272d405`) — на живой странице 167 269 б
|
|||||||
Дополнительно: `ssh naeel@5.172.178.213` без алиаса даёт `Permission denied (publickey)` —
|
Дополнительно: `ssh naeel@5.172.178.213` без алиаса даёт `Permission denied (publickey)` —
|
||||||
рабочий доступ только через алиас `vps` (`~/.ssh/config` → ключ `~/.ssh/naeel_vm_id_ed25519`).
|
рабочий доступ только через алиас `vps` (`~/.ssh/config` → ключ `~/.ssh/naeel_vm_id_ed25519`).
|
||||||
|
|
||||||
## 6. Мои ошибки в этой работе
|
## 6. Порядок разделов и чистка «для юзера» (коммит `bfa9d5f`)
|
||||||
|
|
||||||
|
> Владелец: «ЮЗЕРУ НАХУЙ не интересно ВСЁ это читать! СНАЧАЛА — кратко чё это вообще и ДЕЙСТВИЯ …
|
||||||
|
> всё остальное описание — ПОСЛЕ» → «юзер НЕ МОЖЕТ вводить никакие команды … УБЕРИ ЭТО и подобное».
|
||||||
|
|
||||||
|
Что изменено в `TEST_STAND/CRUD/README.md` и `docs/curated/crud/three_apps.md`:
|
||||||
|
|
||||||
|
- раздел **«Быстрый старт» — первым**: клонирование, заполнение переменных, `apply` в `pg/`,
|
||||||
|
выгрузка `creds.json`, `apply` в `apps/`, адреса приложений, предупреждение про пароль в файле;
|
||||||
|
весь остальной текст — ниже (в README: «Как это устроено», «Что пользователь задаёт сам»,
|
||||||
|
«Код приложений (git)», «Повседневные операции», «Файлы», «Справка»);
|
||||||
|
- убраны из README «Если `apply` упал» и со страницы «Диагностика, если `apply` упал»: содержали
|
||||||
|
`GET {api_endpoint}/instanceOperations/<UID>?...` — вызовы, которые пользователь сделать не может
|
||||||
|
(нет ни `curl`, ни авторизации), и ссылку на `HISTORY/60_stands/…` — файл внутреннего репозитория;
|
||||||
|
- убраны ссылки на внутренний код (`provider/internal/resources_core/crud.go:171`,
|
||||||
|
`provider/internal/core/refsvc_find.go:47`) и на строки примера (`apps/locals.tf:45,57,68`);
|
||||||
|
убран абзац про прежние имена `tflucee`/`tfflask`/`tfnodejs` — внутренняя история;
|
||||||
|
- со страницы убрано «смотрите журнал операции, а не только текст ошибки» (в «Особенности»).
|
||||||
|
|
||||||
|
Проверка (живая страница, `nubes-test/curated/crud/three_apps/`): 162 257 байт, `cmp` с локальной
|
||||||
|
сборкой — совпала; вхождений `instanceOperations`, `errorLog`, `HISTORY/`, `crud.go`, `refsvc_find`
|
||||||
|
— **ноль**; первый раздел — «Быстрый старт».
|
||||||
|
|
||||||
|
## 7. Мои ошибки в этой работе
|
||||||
|
|
||||||
- Разделение `pg/` + `apps/` назвал «разделение ответственности, decoupling» — терминологически
|
- Разделение `pg/` + `apps/` назвал «разделение ответственности, decoupling» — терминологически
|
||||||
неверно (это про модули кода) и заумно. Владелец: «пиши ПРАВИЛЬНО, не надо натягивать заумности».
|
неверно (это про модули кода) и заумно. Владелец: «пиши ПРАВИЛЬНО, не надо натягивать заумности».
|
||||||
@@ -158,6 +181,11 @@ README (коммит `272d405`) — на живой странице 167 269 б
|
|||||||
- В README изначально не было **входа в пример** (как получить файлы — клонирование) и
|
- В README изначально не было **входа в пример** (как получить файлы — клонирование) и
|
||||||
**выхода** (куда зайти после `apply`). Владелец: «где про клонирование???». Ошибка того же
|
**выхода** (куда зайти после `apply`). Владелец: «где про клонирование???». Ошибка того же
|
||||||
рода, что ниже: документировал устройство, а не путь пользователя от нуля до результата.
|
рода, что ниже: документировал устройство, а не путь пользователя от нуля до результата.
|
||||||
|
- Перенёс в README и на страницу нерабочий блок диагностики (`GET {api_endpoint}/…`) и ссылку на
|
||||||
|
`HISTORY/…`, не проверив, может ли читатель этим воспользоваться. Блок был не мой (коммит
|
||||||
|
`00bfe7a`), но перетащил его дальше именно я — секция не моя, а ошибка моя.
|
||||||
|
- Внёс в README сразу много текста вперёд (клонирование + адреса + диагностика), не спросив
|
||||||
|
порядок — владелец потребовал переставить всё так, чтобы сначала были действия.
|
||||||
- Дважды пропустил главное для читателя-новичка: **какие параметры он задаёт своими значениями**
|
- Дважды пропустил главное для читателя-новичка: **какие параметры он задаёт своими значениями**
|
||||||
и **что имена/домены обязаны быть уникальными**. Пришлось напоминать владельцу. Причина одна:
|
и **что имена/домены обязаны быть уникальными**. Пришлось напоминать владельцу. Причина одна:
|
||||||
писал про технику (`apply`, выходы, `creds.json`), а не про то, что нужно человеку в начале.
|
писал про технику (`apply`, выходы, `creds.json`), а не про то, что нужно человеку в начале.
|
||||||
|
|||||||
Reference in New Issue
Block a user