diff --git a/docs/implementation-plan.md b/docs/archive/implementation-plan.md similarity index 100% rename from docs/implementation-plan.md rename to docs/archive/implementation-plan.md diff --git a/docs/pdr-adr.md b/docs/archive/pdr-adr.md similarity index 100% rename from docs/pdr-adr.md rename to docs/archive/pdr-adr.md diff --git a/docs/ux.md b/docs/ux.md new file mode 100644 index 0000000..fd7fe2e --- /dev/null +++ b/docs/ux.md @@ -0,0 +1,46 @@ +# πŸ“„ ΠžΠ±Π½ΠΎΠ²Π»Π΅Π½Π½Ρ‹ΠΉ UX-манифСст + +## ΠžΠΏΡ€Π΅Π΄Π΅Π»Π΅Π½ΠΈΠ΅ контСкста + +- **Папка ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π°:** ΠΏΠ°ΠΏΠΊΠ°, Π² ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΉ Π΅ΡΡ‚ΡŒ `deploy.toml` ΠΈΠ»ΠΈ ΠΏΡƒΡ‚ΡŒ ΠΊ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΉ прописан Π² глобальном ΠΊΠΎΠ½Ρ„ΠΈΠ³Π΅. +- **ΠŸΡ€ΠΈΠΎΡ€ΠΈΡ‚Π΅Ρ‚ Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΈ ΠΊΠΎΠ½Ρ„ΠΈΠ³Π°:** `--config` $\rightarrow$ Ρ„Π°ΠΉΠ» ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π° (`deploy.toml`) $\rightarrow$ Π³Π»ΠΎΠ±Π°Π»ΡŒΠ½Ρ‹ΠΉ ΠΊΠΎΠ½Ρ„ΠΈΠ³. Π€Π»Π°Π³ `--global` (`-g`) ΠΏΡ€ΠΈΠ½ΡƒΠ΄ΠΈΡ‚Π΅Π»ΡŒΠ½ΠΎ оставляСт Ρ‚ΠΎΠ»ΡŒΠΊΠΎ Π³Π»ΠΎΠ±Π°Π»ΡŒΠ½Ρ‹ΠΉ ΠΊΠΎΠ½Ρ„ΠΈΠ³. + +--- + +## 1. Запуск Π±Π΅Π· ΠΏΠΎΠ΄ΠΊΠΎΠΌΠ°Π½Π΄ (`xd [FLAGS]`) + +ΠŸΡ€ΠΎΠ²Π΅Ρ€ΠΊΠ°: находимся Π»ΠΈ ΠΌΡ‹ Π² ΠΏΠ°ΠΏΠΊΠ΅ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π°? + +- **Π”Π°** β€” Π²Ρ‹Π²ΠΎΠ΄ΠΈΡ‚ ΠΊΡ€Π°Ρ‚ΠΊΡƒΡŽ ΠΈΠ½Ρ„ΠΎΡ€ΠΌΠ°Ρ†ΠΈΡŽ ΠΏΠΎ Ρ‚Π΅ΠΊΡƒΡ‰Π΅ΠΌΡƒ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Ρƒ ΠΈ подсказку: + `To deploy current project run 'xd deploy'` +- **НСт** β€” Π²Ρ‹Π²ΠΎΠ΄ΠΈΡ‚ список ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ΠΎΠ² ΠΈΠ· глобального ΠΊΠΎΠ½Ρ„ΠΈΠ³Π°. + +--- + +## 2. Подкоманда `xd deploy [PROJECT_NAME]` + +Π›ΠΎΠ³ΠΈΠΊΠ° опрСдСлСния Ρ†Π΅Π»ΠΈ дСплоя: + +1. **Если `PROJECT_NAME` ΡƒΠΊΠ°Π·Π°Π½:** Π΄Π΅ΠΏΠ»ΠΎΠΈΡ‚ΡŒ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ с этим ΠΈΠΌΠ΅Π½Π΅ΠΌ ΠΈΠ· Ρ‚Π΅ΠΊΡƒΡ‰Π΅Π³ΠΎ ΠΊΠΎΠ½Ρ„ΠΈΠ³Π°. +2. **Если `PROJECT_NAME` НЕ ΡƒΠΊΠ°Π·Π°Π½:** + +- **ΠœΡ‹ Π² ΠΏΠ°ΠΏΠΊΠ΅ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π°** $\rightarrow$ Π΄Π΅ΠΏΠ»ΠΎΠΈΡ‚ΡŒ Ρ‚Π΅ΠΊΡƒΡ‰ΠΈΠΉ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚. +- **ΠœΡ‹ НЕ Π² ΠΏΠ°ΠΏΠΊΠ΅ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π°** $\rightarrow$ Π·Π°Π²Π΅Ρ€ΡˆΠΈΡ‚ΡŒ Ρ€Π°Π±ΠΎΡ‚Ρƒ с понятной ошибкой ΠΈ подсказкой: + `Error: Project not found in current directory. Specify PROJECT_NAME or run 'xd pick' / 'xd list'` + +--- + +## 3. Бписок ΠΏΠΎΠ΄ΠΊΠΎΠΌΠ°Π½Π΄ + +- **`xd deploy [PROJECT]`** β€” Π·Π°ΠΏΡƒΡΡ‚ΠΈΡ‚ΡŒ Π΄Π΅ΠΏΠ»ΠΎΠΉ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π° (Ρ‚Π΅ΠΊΡƒΡ‰Π΅Π³ΠΎ ΠΈΠ»ΠΈ ΡƒΠΊΠ°Π·Π°Π½Π½ΠΎΠ³ΠΎ). +- **`xd list`** (алиас: `ls`) β€” вывСсти список ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ΠΎΠ² ΠΈΠ· Ρ‚Π΅ΠΊΡƒΡ‰Π΅Π³ΠΎ ΠΊΠΎΠ½Ρ„ΠΈΠ³Π°. +- **`xd list-servers`** β€” вывСсти список сСрвСров ΠΈΠ· Ρ‚Π΅ΠΊΡƒΡ‰Π΅Π³ΠΎ ΠΊΠΎΠ½Ρ„ΠΈΠ³Π°. +- **`xd pick`** β€” ΠΈΠ½Ρ‚Π΅Ρ€Π°ΠΊΡ‚ΠΈΠ²Π½Ρ‹ΠΉ Π²Ρ‹Π±ΠΎΡ€ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π° ΠΈΠ· Ρ‚Π΅ΠΊΡƒΡ‰Π΅Π³ΠΎ ΠΊΠΎΠ½Ρ„ΠΈΠ³Π° с ΠΏΠΎΡΠ»Π΅Π΄ΡƒΡŽΡ‰ΠΈΠΌ Π΄Π΅ΠΏΠ»ΠΎΠ΅ΠΌ. + +--- + +## 4. Π“Π»ΠΎΠ±Π°Π»ΡŒΠ½Ρ‹Π΅ Ρ„Π»Π°Π³ΠΈ (доступны для Π»ΡŽΠ±Ρ‹Ρ… ΠΏΠΎΠ΄ΠΊΠΎΠΌΠ°Π½Π΄) + +- **`-c, --config `** β€” ΠΏΡƒΡ‚ΡŒ ΠΊ Ρ„Π°ΠΉΠ»Ρƒ ΠΊΠΎΠ½Ρ„ΠΈΠ³ΡƒΡ€Π°Ρ†ΠΈΠΈ. +- **`-g, --global`** β€” ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ Ρ‚ΠΎΠ»ΡŒΠΊΠΎ Π³Π»ΠΎΠ±Π°Π»ΡŒΠ½Ρ‹ΠΉ ΠΊΠΎΠ½Ρ„ΠΈΠ³ (_ΠΊΠΎΠ½Ρ„Π»ΠΈΠΊΡ‚ΡƒΠ΅Ρ‚ с `--config_`). +- **`--dry-run`** β€” ΠΏΡ€ΠΎΠ³ΠΎΠ½ Π±Π΅Π· выполнСния дСйствий.