Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quick Start Guide and CLI installation guide updates for the Cloud CLI #2119

Merged
merged 21 commits into from
Jun 12, 2024

Conversation

pwizla
Copy link
Collaborator

@pwizla pwizla commented Jun 4, 2024

This PR:

  • reworks the Quick Start Guide (QSG) to introduce the "Cloud CLI" and reflect the new default behavior of create-strapi-app
  • updates the CLI installation guide, mostly by adding a section on how to handle your project in case of self-serve (i.e., copying and pasting instructions for GitHub repository hosting from the old version of the QSG)

Direct preview links
👉 QSG
👉 New section in the CLI install. guide

Note: Screenshots and GIFs might not be final, esp. in dark mode. It requires a significant amount of time to produce them so I'd rather we agree on the content before fine-tuning them 🙏

Copy link

vercel bot commented Jun 4, 2024

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

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 11, 2024 9:11am

@pwizla pwizla self-assigned this Jun 4, 2024
@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs pr: updated content PRs updating existing documentation content flag: merge pending release Pending Strapi Release labels Jun 4, 2024

</Tabs>
<ThemedImage
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

TODO: produce Dark mode version of the GIF

Copy link
Member

Choose a reason for hiding this comment

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

Plus, maybe record it again once it's in production as we can see the qa-strapi in the GIF itself

@pwizla
Copy link
Collaborator Author

pwizla commented Jun 5, 2024

Thanks, @innerdvations, I directly applied all your suggestions!

@pwizla pwizla requested a review from innerdvations June 5, 2024 13:15
Copy link
Member

@nathan-pichon nathan-pichon left a comment

Choose a reason for hiding this comment

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

lgtm! Thanks 🙏

@pwizla pwizla added this to the 4.24.6 milestone Jun 12, 2024
@pwizla pwizla merged commit 87cb5d3 into cloud/cli Jun 12, 2024
3 checks passed
@pwizla pwizla deleted the cloud/cli-quick-start-guide branch June 12, 2024 09:06
@pwizla pwizla mentioned this pull request Jun 12, 2024
5 tasks
pwizla added a commit that referenced this pull request Jun 12, 2024
* Write 1st draft of Cloud CLI + Update TOC

* Improve and complete Cloud CLI documentation

* Create file + Write guide for deploying projects with CLI

* Update deploy introduction + project deploy guide for Cloud dashboard

* Update TOC

* Update TOC + Comment some paragraphs that may not be included in final version

* Improve wording

* Update wording for "hosted on remote git repo"

Co-authored-by: Pierre Wizla <[email protected]>

* Improve wording again for "hosted on remote git repo"

Co-authored-by: Pierre Wizla <[email protected]>

* Improve wording again

Co-authored-by: Pierre Wizla <[email protected]>

* Update docusaurus/docs/cloud/cli/cloud-cli.md

Co-authored-by: Pierre Wizla <[email protected]>

* Keep improving wording

Co-authored-by: Pierre Wizla <[email protected]>

* Remove unnecessary comments

* Update docs after blitz session test

* Improve after review

* Add link to Dev Docs + Fix wording

* Quick Start Guide and CLI installation guide updates for the Cloud CLI (#2119)

* Update the Quick Start Guide to reflect new Cloud CLI behavior

* Update the CLI installation docs

* Add cross-link to QSG to CLI install. guide

* Update docusaurus/docs/dev-docs/quick-start.md

* Update docusaurus/docs/dev-docs/quick-start.md

* Update docusaurus/docs/dev-docs/quick-start.md

* Update docusaurus/docs/dev-docs/quick-start.md

* Update docusaurus/docs/dev-docs/installation/cli.md

Co-authored-by: Ben Irvin <[email protected]>

* Update docusaurus/docs/dev-docs/installation/cli.md

Co-authored-by: Ben Irvin <[email protected]>

* Update docusaurus/docs/dev-docs/quick-start.md

Co-authored-by: Ben Irvin <[email protected]>

* Update docusaurus/docs/dev-docs/quick-start.md

Co-authored-by: Ben Irvin <[email protected]>

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/installation/cli.md

* Update docusaurus/docs/dev-docs/quick-start.md

* Swap NPM & Yarn tabs order

* Shorten text

---------

Co-authored-by: Ben Irvin <[email protected]>

* Add "Updated" badge to QSG in TOC

* Update completion time in QSG

---------

Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Ben Irvin <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
@pwizla pwizla added temp: port to v5 Temporary label for PRs that need to be ported to v5 docs and removed flag: merge pending release Pending Strapi Release labels Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: updated content PRs updating existing documentation content source: Dev Docs PRs/issues targeting the Developer Docs temp: port to v5 Temporary label for PRs that need to be ported to v5 docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants