docs(cloud): Rewrite Introduction, refresh Install scloud, relabel Get started#578
docs(cloud): Rewrite Introduction, refresh Install scloud, relabel Get started#578developerjamiu wants to merge 2 commits into
Conversation
developerjamiu
added
documentation
Zfinix
left a comment
Zfinix
left a comment
There was a problem hiding this comment.
Looks great, nice quality reduction, its easier to follow and more effcient
| --- | ||
|
|
||
| # Installation | ||
| # Install scloud |
There was a problem hiding this comment.
I think a nice scloud banner immage would really upsell this page
Swiftaxe
left a comment
Swiftaxe
left a comment
There was a problem hiding this comment.
A really clean intro page! I added a few comments. I think of the user who may hesitate by "what do I commit to" when just launching my project to the cloud. Do we answer all the questions a user has before they are ready to move on to installation?
| ## Zero-configuration deployments | ||
|
|
||
| Deploy your Serverpod server directly from your project directory using the command line or integrate it into your CI/CD pipeline. No manual VM setup, container configuration, or infrastructure orchestration is needed. | ||
| Deploy is two commands. No Dockerfile, no container config, no infrastructure setup: |
There was a problem hiding this comment.
This first sentence "Deploy is two commands" is a bit fuzzy and confusing.
The actual deploy command after the launch is just scloud deploy.
Also, following this is the install command.
Does it mean something like "Your first deploy is two commands away"?
| ## What Cloud manages | ||
|
|
||
| The Serverpod framework has built-in support for sending messages between your servers, and caching objects works out of the box. We are working on building a service native to Serverpod Cloud; in the meantime, it's easy to configure a 3rd party service. | ||
| - **Runtime and scaling.** Your app runs on a production runtime that scales automatically. |
There was a problem hiding this comment.
This new lightweight list is great. However, a user considering Serverpod Cloud for a serious production app might want to delve deeper into each section, or a specific section. Perhaps link out to a page containing more details on each feature (ie preserve the lengthier explanations on an in-depth page).
| Serverpod Cloud comes with Serverpod Insights, our visual log viewer, preconfigured (requires a database). This gives you access to our world-class logging and server monitoring. | ||
|
|
||
| ## PubSub and caching | ||
| ## What Cloud manages |
There was a problem hiding this comment.
I think it's better to use the Service's full name here.
| ## What Cloud manages | |
| ## What Serverpod Cloud manages |
|
|
||
| # Introduction | ||
|
|
||
| **Serverpod Cloud** is a fully managed hosting platform for Serverpod apps. It lets you deploy and run your Serverpod backend from the command line or via CI/CD. The platform manages all infrastructure needed to run your service in production. It can seamlessly scale to any size, and pricing is predictable. Serverpod Cloud handles networking, load balancing, custom domain names, and your database. |
There was a problem hiding this comment.
This is a decision page. We are dropping some important keywords for the user here, like 'predictable pricing,' which is not listed below.
3 participants
First PR of the Cloud IA rollout (#568).
Changes
cloud_docs/index.md: Introduction rewritten from a feature tour into a conceptual overview. Drops the 8 H2 sections in favour of a short pitch, a small code sample, a "What Cloud manages" bullet list, and "Where to go next" links. Every capability the old page surfaced is preserved in bullet form (Flutter web hosting, Insights' database requirement, PubSub/caching/file storage roadmap).cloud_docs/01-getting-started/01-installation.md: addedtitle: Install scloud, retitled the page, swappeddart pub global activate→dart install(the Dart 3.10+ install command), small wording cleanups.cloud_docs/01-getting-started/_category_.json: sidebar label "Getting started" → "Get started".I believe humans and LLMs will now find these pages easier to scan, understand and expand on through checking other pages (to be added or improved).
Verification
dart install --helpandscloud launch --helpconfirm the commands.npm run buildpasses.What's next
PR 2: Deployments concept (NEW). PR 3: Deploy your first app rewrite (uses PR 2). Full rollout sequence in the #568 tracking comment.
New Intro:
New Installation: