Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
543 commits
Select commit Hold shift + click to select a range
aa20a8a
Fix shortcuts note again
meganelacheny Jan 8, 2024
d564e2b
Add information about the period before project deletion when suspended
meganelacheny Jan 8, 2024
525dcab
chore: fix relative paths on models page (#1968)
kkukelka Jan 8, 2024
a5bfe15
fix: broken nodejs releases link (#1967)
dev-shetty Jan 8, 2024
db3a1bb
Add more precisions about the emails sent before project cancellation
meganelacheny Jan 9, 2024
2f012cb
Update docusaurus/docs/dev-docs/admin-panel-customization.md
pwizla Jan 9, 2024
a11827d
Update docusaurus/docs/dev-docs/admin-panel-customization.md
pwizla Jan 9, 2024
d9c32e5
Update docusaurus/docs/dev-docs/admin-panel-customization.md
pwizla Jan 9, 2024
1f56903
Update docusaurus/docs/dev-docs/admin-panel-customization.md
pwizla Jan 9, 2024
0dcc863
Update docusaurus/docs/dev-docs/cli.md
pwizla Jan 9, 2024
f5e4b91
Update docusaurus/docs/dev-docs/cli.md
pwizla Jan 9, 2024
c4970d5
Update docusaurus/docs/dev-docs/cli.md
pwizla Jan 9, 2024
aae45a1
Update authentication.md (#1970)
seanburlington Jan 9, 2024
0150d52
Update authentication.md
pwizla Jan 9, 2024
5af8f71
Merge pull request #1924 from strapi/user/moving-blocks
meganelacheny Jan 10, 2024
4e2a9e4
Bump version to 4.17.0
meganelacheny Jan 10, 2024
50e803d
Add default column to options tables
pwizla Jan 11, 2024
0545cf8
Add exhaustive list of markdown shortcuts in Blocks documentation
meganelacheny Jan 11, 2024
1f2a9fd
Updates to the Releases feature for the beta release (#1971)
pwizla Jan 12, 2024
0a446e0
Update docs for autogenerate settings for JS projects
pwizla Jan 12, 2024
1a04787
Revert "Update docs for autogenerate settings for JS projects"
pwizla Jan 12, 2024
8789a52
Revert unrelated change
pwizla Jan 12, 2024
a6ba364
Mention API prefix config. in REST API intro.
pwizla Jan 15, 2024
93fae49
fixed sso okta caution block placement (#1976)
Abdullahxz Jan 15, 2024
ad82c46
Err code with `./extensions` (#1977)
thomasbnt Jan 16, 2024
f98da40
Mention other front-end renderers available on npm
pwizla Jan 16, 2024
ac4f7eb
Tweak link from previous commit
pwizla Jan 16, 2024
875f36b
Slightly tweak wording from prev. commit
pwizla Jan 16, 2024
462f718
Update configuring-fields-content-type.md
pwizla Jan 16, 2024
df0b7fb
Remove badges and mentions of future flags
pwizla Jan 17, 2024
f8bbac9
Remove mention of beta for grouping
pwizla Jan 17, 2024
d7fca57
Fix headings
pwizla Jan 17, 2024
607d5cc
Fix icon
pwizla Jan 17, 2024
7d80c5c
Mention validation errors
pwizla Jan 17, 2024
2e44881
Additional fixes
pwizla Jan 17, 2024
f43a058
Temporarily hide features config. docs
pwizla Jan 17, 2024
02ff717
Update with status column and validation errors
pwizla Jan 17, 2024
f7955ea
Strapi Cloud: Node version feature (#1978)
meganelacheny Jan 17, 2024
5146e46
Reviewed & complete version of Strapi Cloud documentation (#1961)
meganelacheny Jan 17, 2024
371ac72
Update package.json
pwizla Jan 17, 2024
6e0092a
Strapi Cloud: mandatory billing details (#1981)
meganelacheny Jan 17, 2024
7300c04
Apply commit from #1982
pwizla Jan 18, 2024
289f2b7
Apply fix from #1972 to email config. too
pwizla Jan 18, 2024
3c59f21
Update admin-panel-customization.md
zlaazlaa Jan 19, 2024
4d020f3
Mention that only collection type entries can be added to releases
pwizla Jan 19, 2024
bfdf9b3
Update headings to avoid confusion re. 'single'
pwizla Jan 19, 2024
9df1016
Fix capitalization
pwizla Jan 19, 2024
7ce04fe
Merge branch 'main' of github.com:strapi/documentation
pwizla Jan 19, 2024
b1728c6
Fix sizeLimit TS code example for upload plugin
pwizla Jan 19, 2024
f861066
Merge branch 'main' into cloud/backups-UI
pwizla Jan 23, 2024
3197287
Add note about maintainers vs project owners for restore backup feature
meganelacheny Jan 23, 2024
ac34f85
Merge pull request #1969 from strapi/cloud/expansion-suspension-period
meganelacheny Jan 24, 2024
c03f25f
Merge pull request #1928 from strapi/cloud/backups-UI
meganelacheny Jan 24, 2024
88ccc4a
Merge pull request #1973 from strapi/user/blocks-shortcuts
meganelacheny Jan 24, 2024
93e14ab
Merge pull request #1980 from strapi/user/releases-stable-updates
meganelacheny Jan 24, 2024
9979c26
Merge pull request #1963 from strapi/feat/add-vite
meganelacheny Jan 24, 2024
9381ab2
Merge pull request #1975 from strapi/dev/autogenerate-updates
meganelacheny Jan 24, 2024
5b22ffc
Update package.json
meganelacheny Jan 24, 2024
ba3d98e
Merge branch 'user/releases-stable-updates'
pwizla Jan 24, 2024
0dcab63
Merge branch 'main' of github.com:strapi/documentation
pwizla Jan 24, 2024
9be4a65
Fix more.icon
pwizla Jan 24, 2024
42660c0
Try again to fix "more" icon 🤞
pwizla Jan 24, 2024
4a16c44
Fix Tab → TabItem component name
pwizla Jan 24, 2024
b6c456d
Revert moremore.svg icon naming to more.svg
pwizla Jan 24, 2024
8824a2c
Introduce Strapi Cloud in the Quick Start Guide (#1979)
pwizla Jan 26, 2024
781958f
update heroku cli ubuntu install command (#1986)
stromseng Jan 26, 2024
1446da2
mention local file upload path (#1990)
nikita-fuchs Jan 29, 2024
0c34e84
Warn against using locale for custom attribute name in Dev Docs
pwizla Jan 30, 2024
5f9034f
Warn against using locale for a custom attribute name in User Guide
pwizla Jan 30, 2024
07ada49
Update wording from prev. commit
pwizla Jan 30, 2024
9a7b18b
Add link to Paul's blog post about TS in front-end
pwizla Jan 31, 2024
2344b3c
Bump version to 4.19.1
pwizla Jan 31, 2024
13da474
Remove unneeded callout for Audit Logs being EE
pwizla Jan 31, 2024
6798c06
Adjusted Typescript Typo fix (#1996)
MbonuJennifer Feb 2, 2024
d64a6e8
Added new dependencies (#2001)
Feb 6, 2024
193d306
Remove outdated mention about single types
pwizla Feb 6, 2024
e1b2ba2
Remove Content Source Map / Vercel Visual Editing documentation (#2003)
pwizla Feb 6, 2024
bad2954
Fix rendering issue in CLI reference page
pwizla Feb 7, 2024
8cd10ad
Merge pull request #2002 from strapi/user/releases-adding-single-types
meganelacheny Feb 7, 2024
26395fe
Update package.json
meganelacheny Feb 7, 2024
89a8828
Replace images with stripped EXIF data (#2005)
pwizla Feb 7, 2024
3cc02b3
Mention formatter disabling in contribution guide
pwizla Feb 8, 2024
c57a0f0
Update wording from last commit
pwizla Feb 8, 2024
0daea6e
Update usage & billing page
meganelacheny Feb 12, 2024
143bd1e
Finish updating Usage & Billing page
meganelacheny Feb 13, 2024
d689895
Fix info about overages rates
meganelacheny Feb 13, 2024
87ca8e4
Mention Developer plan in Project creation
meganelacheny Feb 13, 2024
0862adb
Mention Developer plan for Backups
meganelacheny Feb 13, 2024
dc667dd
Improve links
meganelacheny Feb 13, 2024
94f5cd2
Update project settings to mention upgrade or downgrade
meganelacheny Feb 13, 2024
f18982d
Improve wording
meganelacheny Feb 13, 2024
62a9e27
Add information regarding downgrading in Account billing details
meganelacheny Feb 13, 2024
0bfafa5
Update screenshots to show Dev plan
meganelacheny Feb 13, 2024
7178ee4
Add updated badges in TOC
meganelacheny Feb 13, 2024
03d6242
Fix mistake about Dev plan and Backups
meganelacheny Feb 13, 2024
fb746dc
Add information about backups when downgrading
meganelacheny Feb 13, 2024
aac8467
Fix broken link
meganelacheny Feb 15, 2024
5ca68c9
Fix overages rate for asset storage
meganelacheny Feb 15, 2024
ccd529c
Add a small callout for good practices re. controllers vs. middleware…
pwizla Feb 16, 2024
c54e33f
Update admin-redirect.md (#2018)
eskres Feb 16, 2024
6f66796
Merge pull request #2013 from strapi/cloud/dev-tier
meganelacheny Feb 16, 2024
5a0c8e6
Update package.json
meganelacheny Feb 16, 2024
7f245a7
Update users-permissions.md (#2019)
eskres Feb 16, 2024
00dc22d
feat: add plugin cli docs page (#1965)
joshuaellis Feb 20, 2024
a88be96
Mention experimental Plugin CLI in plugin creation page
pwizla Feb 20, 2024
c4bdd14
Added .dockerignore to documentation as this is essential when using …
Feb 21, 2024
7b82c6e
Strapi Cloud: reconnect a repo (#2023)
meganelacheny Feb 21, 2024
684cfb3
chore: node 20 installation (#2004)
ramadanomar Feb 21, 2024
1911bad
Bump version to 4.20.2
pwizla Feb 21, 2024
e0676ac
Update sidebar with badges
pwizla Feb 21, 2024
ba164a0
Fix wrong default value of develop `--open` option (#2029)
bootleq Feb 22, 2024
6d7ce95
Add new callout to Dev Docs intro
pwizla Feb 23, 2024
3dfad17
Add callout to User Guide intro
pwizla Feb 23, 2024
e55a0c7
Add "where is my content callout?" to CLI install. docs
pwizla Feb 23, 2024
e5a2dfc
fix: typo (#2031)
xylocone Feb 26, 2024
76d3d9b
Fix typo in DigitalOcean guide
pwizla Feb 26, 2024
92083e1
Improve the Plugins configuration section to mention Upload/Media Lib…
pwizla Feb 27, 2024
6caf659
Fix typo in Dev Docs intro.
pwizla Feb 28, 2024
585a215
Update CONTRIBUTING.md
pwizla Feb 28, 2024
8cf8da3
Created new Dev badge and Updated documentation with appropriate badg…
MbonuJennifer Feb 28, 2024
200d804
Update Releases documentation with Scheduling (#2025)
pwizla Feb 29, 2024
f66bb91
Update package.json
meganelacheny Feb 29, 2024
b5eaf7c
Add docs for disabling the growth experiments
derrickmehaffy Mar 1, 2024
46b9e7d
Merge pull request #2035 from strapi/dev/adminFlags
derrickmehaffy Mar 1, 2024
7dac70f
Mention Upload plugin API in REST API
pwizla Mar 6, 2024
c6e5862
Add missing closing parenthesis to last commit
pwizla Mar 6, 2024
7bb2635
Created an Introduction page for the User Guide and the General Setti…
MbonuJennifer Mar 6, 2024
0607918
Replace screenshots with new signup page (#2033)
meganelacheny Mar 6, 2024
e1ac986
Convert alpha badge to beta (#2039)
pwizla Mar 6, 2024
365d033
Bump version to 4.20.4
pwizla Mar 6, 2024
a932843
Fix previous commit 😅
pwizla Mar 6, 2024
ff653c5
🔌 Upload plugin backend example (#2043)
Zetjen Mar 11, 2024
bbd0d3e
Clarify generate types command usage for TypeScript (#2042)
nikita-fuchs Mar 11, 2024
f1fe6b5
Strapi Cloud: new introduction & fundamentals page (#2040)
meganelacheny Mar 13, 2024
91a8428
Strapi Cloud: removing one-time password in "Managing subscriptions" …
meganelacheny Mar 13, 2024
b3a53f7
Bump version to 4.20.5
pwizla Mar 13, 2024
49c78ce
Clarify `populate` usage (#2034)
pwizla Mar 13, 2024
9f02922
Fix messing up with TOC for REST
pwizla Mar 13, 2024
e55a52b
Mention populate deep and fix typo
pwizla Mar 13, 2024
c3fb367
Cloud documentation update & fix (#2059)
meganelacheny Mar 18, 2024
88ba194
Improve intro. sentence for populate guide
pwizla Mar 19, 2024
9c8a89f
Slightly update REST API intro.
pwizla Mar 19, 2024
f3a0dac
Add callout to lifecycle hooks to cross-link to error handling docs (…
MbonuJennifer Mar 19, 2024
4d12cea
Add blog link to populate article by Paul
pwizla Mar 20, 2024
3468ddf
Add docs for keycloak users-permissions provider (#2048)
derrickmehaffy Mar 20, 2024
a2bd3f8
Updates for stable release of Releases Scheduling (#2061)
pwizla Mar 20, 2024
5985206
Bump version to 4.21.0
pwizla Mar 20, 2024
1cd3cf2
Add banner for Strapi 5
pwizla Mar 25, 2024
86bdf19
Update QSG command to beta
pwizla Mar 25, 2024
67a2b14
Revert "Update QSG command to beta"
pwizla Mar 25, 2024
8d4d386
Update banner link to v5 what's new page
pwizla Mar 25, 2024
367a2f6
fix: fix a version issue that happens on the newer builds of alpine-l…
raphaelluethy Mar 26, 2024
23fdc8f
Update .sclt-changelog.json
pwizla Mar 26, 2024
04d2a4b
Fix table overflow behavior on mobile (#2062)
nc1z Mar 26, 2024
2c9d826
add a small note about the overages project deletion check (#2064)
kibwashere Mar 27, 2024
7a3db56
Include blog post link to Unit Testing article
pwizla Mar 27, 2024
ca1bfa1
Add new guides section to REST API (#2065)
pwizla Mar 27, 2024
6929af8
Bump version to 4.21.1
pwizla Mar 27, 2024
a7e27c5
Customize Cloud Backup anchor id
pwizla Mar 27, 2024
6b3e3da
Fix: Typo. Balance some brackets. (#2068)
saitheninja Mar 28, 2024
205820c
Adding bash command to list strapi controllers (#2069)
abhisharkjangir Apr 2, 2024
9263592
Uncomment instructions for list view editing
pwizla Apr 2, 2024
03a1ea7
Revert "Adding bash command to list strapi controllers (#2069)"
pwizla Apr 2, 2024
16be144
Revert "Revert "Adding bash command to list strapi controllers (#2069)""
pwizla Apr 2, 2024
ea4e115
Document bulk add to releases - CM list view (#2070)
pwizla Apr 3, 2024
420c59e
Bump version to 4.22.0
pwizla Apr 3, 2024
6a13e57
Remove completed TODO
pwizla Apr 3, 2024
d0f8a6f
Mention where images are stored
pwizla Apr 3, 2024
cdfaf02
Fix wrong link in admin panel config.
pwizla Apr 3, 2024
d50433d
chore(): small chore to update upload path on ~/documentation/docusau…
SpeedAD Apr 4, 2024
850374e
Fix #2052 (#2075)
pwizla Apr 8, 2024
eb3e181
Fix missing internal documentation link (#2077)
noahismith Apr 10, 2024
68685d6
Bump version to 4.23.0
pwizla Apr 10, 2024
093854f
Improve wording for the “Improve this page” link (#2079)
MbonuJennifer Apr 11, 2024
e33c6b8
Remove emoji from new contribute link
pwizla Apr 12, 2024
5476cb6
Bump version to 4.23.1
pwizla Apr 17, 2024
55baffd
Update 11ty.md (#2088)
b3nks Apr 20, 2024
c9c7fb5
Add missing available options for the client database configuration (…
pwizla Apr 22, 2024
05167cb
updated icons to include links as well on homepage (#2090)
MbonuJennifer Apr 23, 2024
7da45e0
Document using strapi instance for migrations (#2085)
nc1z Apr 23, 2024
d115c33
fix: fix example code (#2094)
imyuanx Apr 29, 2024
3bb1327
Add temp. redir. while corporate website is hot fixed
pwizla Apr 29, 2024
619d012
Fix JSON from latest redir. commit
pwizla Apr 29, 2024
84e2e16
Add an intro. to sanitization and validation
pwizla Apr 30, 2024
503f09a
Add temp. redir. for SSO link from corp. website
pwizla Apr 30, 2024
094a6e5
Update single-sign-on.md
pwizla Apr 30, 2024
a1b3281
Update review-workflows.md
pwizla Apr 30, 2024
b86f5ae
Clean up temporary redirs
pwizla Apr 30, 2024
5dec2e2
Re-add temp. redir.
pwizla Apr 30, 2024
b92abfd
Re-add temp. redir. while corp. website is re-deployed
pwizla Apr 30, 2024
f16f32f
pr: chore - Improving routes page (#2097)
lcpichette May 2, 2024
58f84d0
Estimation of time to complete all the steps at the beginning of the …
MbonuJennifer May 3, 2024
f047912
Security information update to users-permissions
derrickmehaffy May 8, 2024
c6d0f3f
add images
derrickmehaffy May 8, 2024
528f7e0
Merge pull request #2107 from strapi/sec/up
derrickmehaffy May 8, 2024
0aa1f9e
Rewording of TOC/sidebar introduction labels (#2111)
MbonuJennifer May 21, 2024
bcb6cd3
Update admin-panel-customization.md (#2105)
projectashik May 21, 2024
9865fbf
fix: import should be same directory ../ -> ./ (#2104)
qraxiss May 21, 2024
fd42583
Update database.md (#2108)
voicewise May 21, 2024
95adfd0
Fixed file structure alignment (#2102)
benhovinga May 21, 2024
6ebd24b
Created component for numbered lists referring to annotated screensho…
MbonuJennifer May 21, 2024
8a0a922
Fix middlewares docs
pwizla May 21, 2024
962ba21
Fix missing space
pwizla May 21, 2024
c138cfd
Mention findMany returns object for single types in ES API
pwizla May 21, 2024
8ebf700
Duplicate deploy on push option for Update repository modal documenta…
meganelacheny May 23, 2024
f625bd2
Update custom fields options description type (#2115)
kynatro May 24, 2024
2e88ec7
Update package.json
pwizla May 24, 2024
4dd68c2
Merge pull request #2114 from strapi/cloud/update-repo-modal
cache-your-dreams May 24, 2024
cd43568
Update admin-redirect.md (#2113)
Juuhz May 27, 2024
1125516
Fix broken links
pwizla May 29, 2024
7d5b840
Fix typo
pwizla May 29, 2024
08eb2f2
Update package.json
pwizla May 29, 2024
d9835ff
Improve limitations note in custom fields docs
pwizla May 31, 2024
e897de3
Update CONTRIBUTING.md
pwizla May 31, 2024
cf23bcc
Swap NPM & yarn tabs order in the QSG
pwizla Jun 7, 2024
193bf24
Update intro.md
pwizla Jun 11, 2024
3658177
PostHog integration (#2122)
pwizla Jun 11, 2024
5819d7b
Update docusaurus.config.js
pwizla Jun 11, 2024
4d396b0
Update docusaurus.config.js
pwizla Jun 11, 2024
b90c8ac
Cloud CLI documentation (#2086)
meganelacheny Jun 12, 2024
013e02f
Bump version number to 4.25.0
pwizla Jun 12, 2024
2a050ef
Mention you can't upload HTML files during trial
pwizla Jun 17, 2024
bf36169
Update deployment.md
pwizla Jun 17, 2024
6d43f88
Update error-handling.md
pwizla Jun 17, 2024
c2f15f4
Amend database docs about external databases
pwizla Jun 19, 2024
742d5d5
Update database.md
pwizla Jun 19, 2024
b0af45d
Mention Cloud CLI commands in Dev Docs CLI reference
pwizla Jun 24, 2024
810732d
Fix preposition usage in prev. commit
pwizla Jun 24, 2024
52ce924
Digital Ocean Droplet Deployment Edit: Add info about nginx max file …
abuhelos Jun 24, 2024
e984be8
Edit top banner for Strapi 5 RC
pwizla Jun 25, 2024
0acfa51
Update the cloud cli logout step (#2134)
abdallahmz Jun 26, 2024
de9d2c3
Billing flow revamp (#2130)
meganelacheny Jun 26, 2024
bf18bd3
Update to Cloud CLI docs re. connecting a git repo. (#2128)
pwizla Jun 26, 2024
aa497a2
Merge branch 'repo/five-rc'
pwizla Jun 26, 2024
affc7b5
Capitalize RC (#2136)
pwizla Jun 26, 2024
aa6a8c8
Add PostHog React test
pwizla Jun 27, 2024
44995d8
Add fetch-related blog post link to REST API guides list (#2139)
pwizla Jul 1, 2024
6a918a0
Add link to blog post about using fetch() with the REST API
pwizla Jul 1, 2024
da26c38
Add redir. for REST API guides intro.
pwizla Jul 1, 2024
2ebd1fe
Add FAQ entry about Strapi Cloud upgrade (#2140)
pwizla Jul 1, 2024
ed972d9
Update usage-billing.md
pwizla Jul 2, 2024
8922764
Update usage-information.md
pwizla Jul 2, 2024
3b8d8fa
Remove duplicate TOC items
pwizla Jul 3, 2024
ba0ada8
Update QSG to match new CLI behavior (#2133)
pwizla Jul 3, 2024
845c6d1
Bump version number to 4.5.2
pwizla Jul 3, 2024
2f18ef7
feat(cli): strapi projects
gonbaum Jul 16, 2024
31ab6dc
Merge pull request #2144 from strapi/cli/projects-list
gonbaum Jul 16, 2024
e6003d2
Update Algolia API key
pwizla Jul 16, 2024
0ed4fd2
Merge branch 'main' of github.com:strapi/documentation
pwizla Jul 16, 2024
5698f06
Merge branch 'strapi:main' into main
zlaazlaa Jul 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Cloud CLI documentation (#2086)
* 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]>
  • Loading branch information
4 people authored Jun 12, 2024
commit b90c8ac0d28818ddf0746ef8810a80ea67423f96
67 changes: 67 additions & 0 deletions docusaurus/docs/cloud/cli/cloud-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
sidebar_label: 'Cloud CLI'
displayed_sidebar: cloudSidebar
sidebar_position: 3
---

# Command Line Interface (CLI)

Strapi Cloud comes with a Command Line Interface (CLI) which allows you to log in and out, and to deploy a local project without it having to be hosted on a remote git repository. The CLI works with both the `yarn` and `npm` package managers.

The Cloud CLI is designed as a CLI-only experience, meaning that users who wish to use Strapi Cloud to deploy their project with the CLI will have to mostly stick to using the CLI (e.g. if you login with the CLI you must logout with the CLI as well, your project deployed with the CLI can only be redeployed with the CLI etc.).

:::note
It is recommended to install Strapi locally only, which requires prefixing all of the following `strapi` commands with the package manager used for the project setup (e.g `npm run strapi help` or `yarn strapi help`) or a dedicated node package executor (e.g. `npx strapi help`).
:::

## strapi login

**Alias:** `strapi cloud:login`

Log in Strapi Cloud.

```bash
strapi login
```

This command automatically opens a browser window to first ask you to confirm that the codes displayed in both the browser window and the terminal are the same. Then you will be able to log into Strapi Cloud via Google, GitHub or GitLab. Once the browser window confirms successful login, it can be safely closed.

If the browser window doesn't automatically open, the terminal will display a clickable link as well as the code to enter manually.

## strapi deploy

**Alias:** `strapi cloud:deploy`

Deploy a new local project (< 100MB) in Strapi Cloud.

```bash
strapi deploy
```

This command must be used after the `login` one. It deploys a local Strapi project on Strapi Cloud, without having to host it on a remote git repository beforehand. The terminal will inform you when the project is successfully deployed on Strapi Cloud.

Once the project is first deployed on Strapi Cloud with the CLI, the `deploy` command can be reused to trigger a new deployment of the same project.

:::caution
The `deploy` command can only be used by new users who have never created a Strapi Cloud project, and for which the free trial is still available. Once a project is deployed with the CLI, it isn't possible to deploy another project on the same Strapi Cloud account with the CLI.
:::

:::note
Once you deployed your project, if you visit the Strapi Cloud dashboard, you may see some limitations as well as impacts due to creating a Strapi Cloud project that is not in a remote repository and which was deployed with the CLI.

- Some areas in the dashboard that are usually reserved to display information about the git provider will be blank.
- Some buttons, such as the **Trigger deploy** button, will be greyed out and unclickable since you can only redeploy your project using the CLI.
- Options such as environment variables, and features like the logs, are not available for CLI-created projects. <!-- to be confirmed -->
:::

## strapi logout

**Alias:** `strapi cloud:logout`

Log out of Strapi Cloud.

```bash
strapi logout
```

This command logs you out of Strapi Cloud. Once the `logout` command is run, the terminal will display a confirmation message that you were successfully logged out, and you will not be able to use the `deploy` command anymore.
80 changes: 80 additions & 0 deletions docusaurus/docs/cloud/getting-started/deployment-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: with Cloud CLI
displayed_sidebar: cloudSidebar
description: Learn how to deploy your Strapi application via the CLI.
canonicalUrl: https://docs.strapi.io/cloud/getting-started/deployment-cli.html
sidebar_position: 2
---

# Project deployment with the Command Line Interface (CLI)

This is a step-by-step guide for deploying your project on Strapi Cloud for the first time, using the Command Line Interface.

:::prerequisites
Before you can deploy your Strapi application on Strapi Cloud using the Command Line Interface, you need to have the following prerequisites:

- Be a first-time Strapi Cloud user: you must never have deployed a project with Strapi Cloud before, and your free trial must still be available.
- Have a Google, GitHub or GitLab account.
- Have an already created Strapi project (see [Installing from CLI in the Developer Documentation](/dev-docs/installation/cli)), stored locally. The project must be less than 100MB.
- Have available storage in your hard drive where the temporary folder of your operating system is stored.
:::

## Logging in to Strapi Cloud

1. Open your terminal.

2. Navigate to the folder of your Strapi project, stored locally on your computer.

3. Enter the following command to log into Strapi Cloud:

<Tabs groupId="yarn-npm">
<TabItem value="yarn" label="Yarn">

```bash
yarn strapi login
```

</TabItem>
<TabItem value="npm" label="NPM">

```bash
npx run strapi login
```

</TabItem>
</Tabs>

4. In the browser window that opens automatically, confirm that the code displayed is the same as the one written in the terminal message.

5. Still in the browser window, choose whether to login via Google, GitHub or GitLab. The window should confirm the successful login soon after.

## Deploying your project

1. From your terminal, still from the folder of your Strapi project, enter the following command to deploy the project:

<Tabs groupId="yarn-npm">
<TabItem value="yarn" label="Yarn">

```bash
yarn strapi deploy
```

</TabItem>
<TabItem value="npm" label="NPM">

```bash
npx run strapi deploy
```

</TabItem>
</Tabs>

2. Follow the progression bar in the terminal until confirmation that the project was successfully deployed with Strapi Cloud.

## ⏩ What to do next?

Now that you have deployed your project via the Command Line Interface, we encourage you to explore the following ideas to have an even more complete Strapi Cloud experience:

- Fill in your [billing information](/cloud/account/account-billing) to prevent your project from being suspended at the end of the trial period.
- Visit the Cloud dashboard to follow [insightful metrics and information](/cloud/projects/overview) on your Strapi project.
- Check out the full [Command Line Interface documentation](/cloud/cli/cloud-cli) to learn about the other commands available.
21 changes: 21 additions & 0 deletions docusaurus/docs/cloud/getting-started/deployment-options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Project deployment
displayed_sidebar: cloudSidebar
description: Learn how to deploy your Strapi application on Strapi Cloud, via the Cloud dashboard or the CLI.
canonicalUrl: https://docs.strapi.io/cloud/getting-started/deployment-options.html
sidebar_position: 2
---

# Project deployment with Strapi Cloud

You have 2 options to deploy your project with Strapi Cloud:

- either with the user interface (UI), meaning that you will perform all the actions directly on the Strapi Cloud dashboard,
- or using the Cloud Comment Line Interface (CLI), meaning that you will only interact with a terminal.

The guides below will guide you through all the steps for each of the deployment options.

<CustomDocCardsWrapper>
<CustomDocCard emoji="🖼️" title="Via the Cloud dashboard" description="Step-by-step guide to create and deploy a project via the user interface." link="/cloud/getting-started/deployment" />
<CustomDocCard emoji="💻" title="Via the CLI" description="Step-by-step guide to create and deploy a project with the Cloud Command Line Interface." link="/cloud/getting-started/deployment-cli" />
</CustomDocCardsWrapper>
36 changes: 22 additions & 14 deletions docusaurus/docs/cloud/getting-started/deployment.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: Project creation
title: with Cloud dashboard
displayed_sidebar: cloudSidebar
description: Learn how to deploy your Strapi application on Strapi Cloud.
canonicalUrl: https://docs.strapi.io/cloud/getting-started/deployment.html
sidebar_position: 2
---

# Project creation & deployment
# Project deployment with the Cloud dashboard

This is a step-by-step guide for creating and deploying your first project on Strapi Cloud.
This is a step-by-step guide for deploying your project on Strapi Cloud for the first time, using the Cloud dashboard.

:::prerequisites
Before you can deploy your Strapi application on Strapi Cloud, you need to have the following prerequisites:
Before you can deploy your Strapi application on Strapi Cloud using the Cloud dashboard, you need to have the following prerequisites:

* Strapi version `4.8.2` or higher
* Project database must be compatible with PostgreSQL. Strapi does not support and does not recommend using any external databases, though it's possible to configure one (see [advanced database configuration](/cloud/advanced/database)).
Expand All @@ -33,7 +33,7 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
}}
/>

## Creating a project
## Deploying a project

1. From the *Projects* page, click the **Create project** button.

Expand All @@ -45,7 +45,7 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
}}
/>

2. You will be redirected to the first project creation interface. This interface contains 3 steps: choosing a plan, connecting a git repository, and setting up the project.
2. You will be redirected to the first project deployment interface. This interface contains 3 steps: choosing a plan, connecting a remote git repository, and setting up the project.

<ThemedImage
alt="Strapi Cloud project creation, step 1"
Expand All @@ -58,12 +58,12 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have
3. Choose a plan for your Strapi Cloud project: either Developer, Pro, Team, or the 14-days free trial. Feel free to refer to [Pricing](https://strapi.io/pricing-cloud) for more information.

:::note
Strapi Cloud offers a free trial for only one project and you will not need to share your credit card details to create your first project. Once the free trial has already been used for a previous project, the option will no longer appear in the plan selection.
Strapi Cloud offers a free trial for only one project and you will not need to share your credit card details to deploy your first project. Once the free trial has already been used for a previous project, the option will no longer appear in the plan selection.
:::

4. Connect a git repository to your new Strapi Cloud project.

:::strapi Choose your path to create your new Strapi Cloud project!
:::strapi Choose your path for your new Strapi Cloud project!
Select one of the tabs below depending on how you wish to proceed:
- by using a prebuilt template and creating a new repository on GitHub to discover Strapi Cloud easily and quickly *(recommended for new users and beginners — not available on another provider than GitHub)*,
- or by using your own, already existing GitHub or GitLab repository and Strapi project.
Expand All @@ -73,7 +73,7 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have

<TabItem value="TEMPLATE" label="New repo & prebuilt template ✨">

4.a. Click on the **Use template** button. If you are creating a project for the first time, you may first have to select GitHub as git provider and then you will see the option to use a template.
4.a. Click on the **Use template** button. If you are deploying a project for the first time, you may first have to select GitHub as git provider and then you will see the option to use a template.

4.b. In the *Create repository with template* modal, choose:

Expand All @@ -93,7 +93,7 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have

4.d. If you have already given Strapi Cloud access to all repositories of your GitHub account, go directly to the next step. If not, you will be redirected to a GitHub modal where you will have to allow Strapi Cloud access to the newly created repository (more information in the [GitHub documentation](https://docs.github.com/en/apps/overview)).

4.e. Back in the project creation interface, select your *Account* and the *Repository* you just created.
4.e. Back in the project deployment interface, select your *Account* and the *Repository* you just created.

<ThemedImage
alt="Selecting GitHub account and repository"
Expand All @@ -107,15 +107,15 @@ Before you can deploy your Strapi application on Strapi Cloud, you need to have

<TabItem value="OWN-REPO" label="Own existing repo & Strapi project">

4.a. (optional) If you are creating a project for the first time, you may first have to select a git provider: either GitHub or GitLab. If you already created a project with one git provider, you can afterward create another project using another provider by clicking on the **Switch git provider** button and selecting either GitHub or GitLab.
4.a. (optional) If you are deploying a project for the first time, you may first have to select a git provider: either GitHub or GitLab. If you already deployed a project with one git provider, you can afterward deploy another project using another provider by clicking on the **Switch git provider** button and selecting either GitHub or GitLab.

:::tip
Connect the GitHub or GitLab account and/or organizations that own the repository or repositories you want to deploy. This can be different from the account that owns the Strapi Cloud account.
:::

4.b. If you have already given Strapi Cloud access to all repositories of your GitHub or GitLab account, go directly to the next step. If not, you will be redirected to a modal where you will have to allow Strapi Cloud permission to access some or all your repositories on GitHub/GitLab (more information in the [GitHub](https://docs.github.com/en/apps/overview) and [GitLab](https://docs.gitlab.com/ee/integration/oauth_provider.html#view-all-authorized-applications) documentations).

4.c. Back in the project creation interface, select your *Account* and a *Repository*.
4.c. Back in the project deployment interface, select your *Account* and a *Repository*.

<ThemedImage
alt="Selecting git account and repository"
Expand Down Expand Up @@ -176,7 +176,7 @@ During the free trial, will be kept informed of the number of remaining free day
👉 Skip to step 5 of the section below to finalise the creation of your project.
:::

1. Click on the **Continue to billing** button. You will directly be redirected to the second and final project creation interface. There you can review all your new project setup information, enter payment & billing details and receive your invoice.
1. Click on the **Continue to billing** button. You will directly be redirected to the second and final project deployment interface. There you can review all your new project setup information, enter payment & billing details and receive your invoice.

<ThemedImage
alt="Payment & Billing"
Expand All @@ -192,8 +192,16 @@ During the free trial, will be kept informed of the number of remaining free day

4. Check your invoice which informs you of what should be paid now and the following month. Optionally, you can enter a *Discount code* if you have one.

5. Click on the **Create project** button to finalize the creation of your new Strapi Cloud project. An initial deployment will automatically be triggered and you will be redirected to the *Projects* page.
5. Click on the **Create project** button to finalize the deployment of your new Strapi Cloud project. An initial deployment will automatically be triggered and you will be redirected to the *Projects* page.

:::caution
Create your Admin user after the initial deployment is complete. Do not share your application URL with anyone until you have created your Admin user.
:::

## ⏩ What to do next?

Now that you have deployed your project via the Cloud dashboard, we encourage you to explore the following ideas to have an even more complete Strapi Cloud experience:

- If you chose the free trial during your first project deployment, make sure to fill in your [billing information](/cloud/account/account-billing) afterward to prevent your project from being suspended at the end of the trial period.
- Invite other users to [collaborate on your project](/cloud/projects/collaboration).
- Check out the [deployments management documentation](/cloud/projects/deploys) to learn how to trigger new deployments for your project.
32 changes: 32 additions & 0 deletions docusaurus/docs/dev-docs/installation/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ The above installation guide only covers the basic installation option using the
- `--typescript`/`--ts`: Create a project in [TypeScript](/dev-docs/typescript).
- `--no-run`: Prevent Strapi from automatically starting the server (useful in combination with `--quickstart`).

- `--skip-cloud`: Automatically answers "Skip" to the Login/Signup question, which prevents the installation script from login into Strapi Cloud (useful in combination with `--quickstart`).

For more information on available flags, see our [CLI documentation](/dev-docs/cli).

Strapi also offers a starters CLI to create a project with a pre-made frontend application (see [our dedicated blog post](https://strapi.io/blog/announcing-the-strapi-starter-cli)).
Expand All @@ -89,6 +91,36 @@ Experimental Strapi versions are released every Tuesday through Saturday at midn
Please use these experimental builds at your own risk. It is not recommended to use them in production.
:::

### Skipping the Strapi Cloud login step

When the installation script runs, the terminal will first ask you if you want to login/signup. Choosing `Login/signup` will create a free, 14-day trial [Strapi Cloud](/cloud/intro#what-is-strapi-cloud) project as described in the [Quick Start Guide](/dev-docs/quick-start).

If you prefer skipping this Strapi Cloud login part, use the arrow keys to select `Skip`. The script will resume and create a local project. To deploy this project and host it online, you could later choose to:
- host it yourself by pushing the project's code to a repository (e.g., on GitHub) before following a [3rd-party deployment guide](/dev-docs/deployment),
- or use the [Cloud CLI](/cloud/cli/cloud-cli) commands to login to Strapi Cloud and deploy your project there.

If you want to host your project yourself and are not already familiar with GitHub, the following togglable content should get you started👇.

<details>
<summary>Steps required to push your Strapi project code to GitHub:</summary>

1. In the terminal, ensure you are still in the folder that hosts the Strapi project you created.
2. Run the `git init` command to initialize git for this folder.
3. Run the `git add .` command to add all modified files to the git index.
4. Run the `git commit -m "Initial commit"` command to create a commit with all the added changes.
5. Log in to your GitHub account and [create a new repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/quickstart-for-repositories). Give the new repository a name, for instance `my-first-strapi-project`, and remember this name.
6. Go back to the terminal and push your local repository to GitHub:

a. Run a command similar to the following: `git remote add origin [email protected]:yourname/my-first-strapi-project.git`, ensuring you replace `yourname` by your own GitHub profile name, and `my-first-strapi-project` by the actual name you used at step 4.

b. Run the `git push --set-upstream origin main` command to finally push the commit to your GitHub repository.

Additional information about using git with the command line interface can be found in the [official GitHub documentation](https://docs.github.com/en/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#adding-a-local-repository-to-github-using-git).

</details>



## Running Strapi

To start the Strapi application, run the following command in the project folder:
Expand Down
Loading