Improve monorepository getting started documentation#1487
Conversation
🦋 Changeset detectedLatest commit: 96d243e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Pull request overview
Updates the “getting started” documentation to center the monorepo bootstrap flow around npx @pagopa/dx-cli init, including prerequisites, GitHub App preparation, and the post-generation infrastructure steps.
Changes:
- Rewrote monorepo setup guide to follow the
dx initend-to-end workflow (GitHub App prep → init → infra apply → repository registration). - Expanded DX CLI docs with a prerequisites section and a detailed
initprompt reference. - Removed the standalone GitHub PAT setup page and added a changeset for the docs package.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| apps/website/docs/monorepository-setup.md | Reframes the monorepo setup as a dx init-driven process and adds post-init operational steps. |
| apps/website/docs/dx-cli/index.md | Adds explicit requirements and a prompt-by-prompt reference for dx init. |
| apps/website/docs/dx-cli/github-pat.md | Removes the PAT setup doc page. |
| .changeset/kind-pillows-trade.md | Publishes the documentation updates as a patch release for the docs package. |
lucacavallaro
left a comment
There was a problem hiding this comment.
I would split the steps in two different sections, based on target audience
- Developers (dx-cli init for an existing product)
- Engineering Leader (github app, initialization, apply of the core module)
951e8aa to
64deaf2
Compare
|
it looks like formatting checks fail |
Done! |
4265223 to
11d505e
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
f56333c to
3248662
Compare
be73fa2 to
875497e
Compare
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://proud-mud-0405c6703-1487.westeurope.1.azurestaticapps.net |
This PR was opened by the [Nx Release](https://github.com/pagopa/dx/tree/main/actions/nx-release) GitHub Action. When you're ready to do a release, you can merge this and the packages will be published automatically. If you're not ready to do a release yet, that's fine, whenever you add more Nx version plans to main, this PR will be updated. # Releases ## @pagopa/dx-cli@0.19.0 ### 🚀 Features - Update dx doctor to check for Nx ([#1554](#1554)) - Generated workspaces now use Nx instead of Turborepo ([#1551](#1551)) - Remove environment initialization from init command ([#1552](#1552)) ### ❤️ Thank You - Copilot @Copilot - Luca Cavallaro ## docs@0.15.0 ### 🚀 Features - Add website docs for DX Copilot plugins ([#1540](#1540)) ### 🩹 Fixes - Update docs with new nx-release action page ([#1486](#1486), [#1510](#1510)) - Improve documentation for monorepositories and dx-cli init command ([#1487](#1487)) - Align documentation for Nx Release instead of Changeset, add new page for Version Plans ([#1570](#1570)) ### ❤️ Thank You - Andrea Grillo - Copilot @Copilot - Danilo Spinelli @gunzip - Luca Cavallaro - Mario Mupo @mamu0 ## github_environment_bootstrap@1.1.8 ### 🩹 Fixes - Do not use the `has_downloads` attribute since it's been deprecated ([#1568](#1568)) ### ❤️ Thank You - Marco Comi @kin0992 ## setup-telemetry-action@0.1.6 ### 🩹 Fixes - Upgrade node version to node24 ([#1567](#1567)) ### ❤️ Thank You - Andrea Grillo - Copilot @Copilot - Marco Comi <!-- nx-release-tags: [{"path":"apps/cli","tag":"@pagopa/dx-cli@0.19.0","version":"0.19.0"},{"path":"apps/website","tag":"docs@0.15.0","version":"0.15.0"},{"path":"infra/modules/github_environment_bootstrap","tag":"github_environment_bootstrap@1.1.8","version":"1.1.8"},{"path":"actions/setup-telemetry","tag":"setup-telemetry-action@0.1.6","version":"0.1.6"}] --> Co-authored-by: dx-pagopa-bot <dx-pagopa-bot@users.noreply.github.com>
This PR was opened by the [Nx Release](https://github.com/pagopa/dx/tree/main/actions/nx-release) GitHub Action. When you're ready to do a release, you can merge this and the packages will be published automatically. If you're not ready to do a release yet, that's fine, whenever you add more Nx version plans to main, this PR will be updated. # Releases ## @pagopa/dx-cli@0.19.0 ### 🚀 Features - Update dx doctor to check for Nx ([#1554](pagopa/dx#1554)) - Generated workspaces now use Nx instead of Turborepo ([#1551](pagopa/dx#1551)) - Remove environment initialization from init command ([#1552](pagopa/dx#1552)) ### ❤️ Thank You - Copilot @Copilot - Luca Cavallaro ## docs@0.15.0 ### 🚀 Features - Add website docs for DX Copilot plugins ([#1540](pagopa/dx#1540)) ### 🩹 Fixes - Update docs with new nx-release action page ([#1486](pagopa/dx#1486), [#1510](pagopa/dx#1510)) - Improve documentation for monorepositories and dx-cli init command ([#1487](pagopa/dx#1487)) - Align documentation for Nx Release instead of Changeset, add new page for Version Plans ([#1570](pagopa/dx#1570)) ### ❤️ Thank You - Andrea Grillo - Copilot @Copilot - Danilo Spinelli @gunzip - Luca Cavallaro - Mario Mupo @mamu0 ## github_environment_bootstrap@1.1.8 ### 🩹 Fixes - Do not use the `has_downloads` attribute since it's been deprecated ([#1568](pagopa/dx#1568)) ### ❤️ Thank You - Marco Comi @kin0992 ## setup-telemetry-action@0.1.6 ### 🩹 Fixes - Upgrade node version to node24 ([#1567](pagopa/dx#1567)) ### ❤️ Thank You - Andrea Grillo - Copilot @Copilot - Marco Comi <!-- nx-release-tags: [{"path":"apps/cli","tag":"@pagopa/dx-cli@0.19.0","version":"0.19.0"},{"path":"apps/website","tag":"docs@0.15.0","version":"0.15.0"},{"path":"infra/modules/github_environment_bootstrap","tag":"github_environment_bootstrap@1.1.8","version":"1.1.8"},{"path":"actions/setup-telemetry","tag":"setup-telemetry-action@0.1.6","version":"0.1.6"}] --> Co-authored-by: dx-pagopa-bot <dx-pagopa-bot@users.noreply.github.com>
Resolves CES-1691, CES-1816