Skip to content

Conversation

@pwizla
Copy link
Collaborator

@pwizla pwizla commented Jun 7, 2024

Direct preview link 👉 here

This PR:

  • reworks the CLI installation guide to mention the new commands and all the (new or updated) possible options.
    (Note: All options are now documented in the CLI installation guide and not in the CLI reference, as the only place where options (like --debug, --db-username etc.) were documented was for the strapi new command but this command has been removed from v5.
  • slightly rework the Quick Start Guide as the command is now shorter: create-strapi-app → create-strapi

Related strapi/strapi PR: strapi/strapi#20268

@vercel
Copy link

vercel bot commented Jun 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ❌ Failed (Inspect) Jun 12, 2024 1:15pm
@pwizla pwizla self-assigned this Jun 7, 2024
@pwizla pwizla added this to the 5.0.0 (stable) milestone Jun 7, 2024
@pwizla pwizla added flag: merge pending release Pending Strapi Release internal PRs created by the Strapi core team v5 Documentation PR that targets Strapi v5 labels Jun 10, 2024

```bash
npx create-strapi-app@beta my-project --quickstart
npx create-strapi@beta my-project --quickstart
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For v5 we should definitely remove the --quickstart option from the guide so users can see all the options instead. We consider it to be deprecated and will be removed in v6

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, Alex!
But if I do this, I need to update the rest of the Quick Start Guide (more questions to answer, etc.).

I won't do it now, because the Quick Start Guide will again change in the following weeks (re. Cloud CLI) and it takes time to update it.

At least now they could use the shorter commands and (hopefully) have roughly the same experience than in the current Quick Start Guide ( = before the Cloud CLI)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In short, for the final (stable, in September) version of the v5 Quick Start Guide I'll remove the --quickstart and ensure users experience the new workflow exactly like it's described. For now, too time consuming in regards of all the other tasks I have to do.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:+1

@pwizla pwizla modified the milestones: 5.0.0 (stable), 5.0.0-beta.10 Jun 12, 2024
@pwizla pwizla merged commit c2b7be7 into next Jun 12, 2024
@pwizla pwizla deleted the v5/cli-updates branch June 12, 2024 13:01
@pwizla pwizla removed the flag: merge pending release Pending Strapi Release label Jun 12, 2024
@pwizla pwizla modified the milestones: 5.0.0 (stable), 5.0.0-rc.0 Jun 26, 2024
@pwizla pwizla modified the milestones: 5.0.0-rc.0, 5.0.0 (stable) Aug 13, 2024
@pwizla pwizla added pr: updated content PRs updating existing documentation content source: Dev Docs PRs/issues targeting the Developer Docs labels Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: Dev Docs PRs/issues targeting the Developer Docs v5 Documentation PR that targets Strapi v5

2 participants