[automated commit] Bump docs to version 1.2.0

platformatic · Oct 6, 2023 · 08a9ec2 · 08a9ec2
1 parent c144bda
commit 08a9ec2
Show file tree

Hide file tree

Showing 140 changed files with 2,559 additions and 17 deletions.
diff --git a/...rsion-0.47.3/contributing/contributing.md → ...ersion-1.2.0/contributing/contributing.md b/...rsion-0.47.3/contributing/contributing.md → ...ersion-1.2.0/contributing/contributing.md
diff --git a/...contributing/documentation-style-guide.md → ...contributing/documentation-style-guide.md b/...contributing/documentation-style-guide.md → ...contributing/documentation-style-guide.md
diff --git a/...on-0.47.3/getting-started/architecture.md → ...ion-1.2.0/getting-started/architecture.md b/...on-0.47.3/getting-started/architecture.md → ...ion-1.2.0/getting-started/architecture.md
@@ -9,7 +9,8 @@ The base services are:
 
 These micro-services can be developed and deployed independently or aggregated into a single API using [Platformatic Composer](#platformatic-composer) or deployed as a single unit using [Platformatic Runtime](#platformatic-runtime).
 
-Finally, platformatic components can be reused with [stackables](#platformatic-stackbles)
+All platformatic components can be reused with [Stackables](#platformatic-stackbles).
+And finally, all Platformatic components can be deployed on [Platformatic Cloud](#platformatic-cloud).
 
 ## Platformatic Service
 
@@ -70,10 +71,18 @@ Platformatic Stackables are reusable components that can be used to build Platfo
 
 This is useful to publish the application on the public npm registry (or a private one!), including building your own CLI, or to create a specialized template for your organization to allow for centralized bugfixes and updates.
 
+## Platformatic Cloud 
+[Platformatic Cloud](https://platformatic.cloud) allows to deploy Platformatic Applications on our cloud for both static deployments and PR reviews. 
+The deployment on the cloud can be done:
+- Automatically using the GitHub actions created with `create-platformatic` 
+- Using the Platformatic CLI (see https://docs.platformatic.dev/docs/reference/cli#deploy)
 
+If you configure the GitHub actions, you can deploy your application on the cloud by simply pushing to the main branch or creating a PR. For a guide about how to do a deploy on Platformatic Cloud, please check the [Platformatic Cloud Quick Start Guide](https://docs.platformatic.dev/docs/platformatic-cloud/quick-start-guide).
 
 
-
-
+:::info
+If you create a PR, we calculate automatically the "risk score" for that PR. For more info about this, 
+see [Calculate the risk of a pull request](https://docs.platformatic.dev/docs/platformatic-cloud/quick-start-guide/#calculate-the-risk-of-a-pull-request).
+:::
 
 
diff --git a/...ting-started/movie-quotes-app-tutorial.md → ...ting-started/movie-quotes-app-tutorial.md b/...ting-started/movie-quotes-app-tutorial.md → ...ting-started/movie-quotes-app-tutorial.md
diff --git a/...g-started/new-api-project-instructions.md → ...g-started/new-api-project-instructions.md b/...g-started/new-api-project-instructions.md → ...g-started/new-api-project-instructions.md
diff --git a/...ing-started/platformatic-architecture.png → ...ing-started/platformatic-architecture.png b/...ing-started/platformatic-architecture.png → ...ing-started/platformatic-architecture.png
diff --git a/...ed/platformatic-composer-architecture.png → ...ed/platformatic-composer-architecture.png b/...ed/platformatic-composer-architecture.png → ...ed/platformatic-composer-architecture.png
diff --git a/...-started/platformatic-db-architecture.png → ...-started/platformatic-db-architecture.png b/...-started/platformatic-db-architecture.png → ...-started/platformatic-db-architecture.png
diff --git a/...ted/platformatic-runtime-architecture.png → ...ted/platformatic-runtime-architecture.png b/...ted/platformatic-runtime-architecture.png → ...ted/platformatic-runtime-architecture.png
diff --git a/.../platformatic-stackables-architecture.png → .../platformatic-stackables-architecture.png b/.../platformatic-stackables-architecture.png → .../platformatic-stackables-architecture.png
diff --git a/...formatid-composer-architecture.excalidraw → ...formatid-composer-architecture.excalidraw b/...formatid-composer-architecture.excalidraw → ...formatid-composer-architecture.excalidraw
diff --git a/...d/platformatid-db-architecture.excalidraw → ...d/platformatid-db-architecture.excalidraw b/...d/platformatid-db-architecture.excalidraw → ...d/platformatid-db-architecture.excalidraw
diff --git a/...tformatid-runtime-architecture.excalidraw → ...tformatid-runtime-architecture.excalidraw b/...tformatid-runtime-architecture.excalidraw → ...tformatid-runtime-architecture.excalidraw
diff --git a/...rmatid-stackables-architecture.excalidraw → ...rmatid-stackables-architecture.excalidraw b/...rmatid-stackables-architecture.excalidraw → ...rmatid-stackables-architecture.excalidraw
diff --git a/...47.3/getting-started/quick-start-guide.md → ....2.0/getting-started/quick-start-guide.md b/...47.3/getting-started/quick-start-guide.md → ....2.0/getting-started/quick-start-guide.md
diff --git a/...dd-custom-functionality/extend-graphql.md → ...dd-custom-functionality/extend-graphql.md b/...dd-custom-functionality/extend-graphql.md → ...dd-custom-functionality/extend-graphql.md
diff --git a/...s/add-custom-functionality/extend-rest.md → ...s/add-custom-functionality/extend-rest.md b/...s/add-custom-functionality/extend-rest.md → ...s/add-custom-functionality/extend-rest.md
diff --git a/.../add-custom-functionality/introduction.md → .../add-custom-functionality/introduction.md b/.../add-custom-functionality/introduction.md → .../add-custom-functionality/introduction.md
diff --git a/...add-custom-functionality/prerequisites.md → ...add-custom-functionality/prerequisites.md b/...add-custom-functionality/prerequisites.md → ...add-custom-functionality/prerequisites.md
diff --git a/...uides/add-custom-functionality/raw-sql.md → ...uides/add-custom-functionality/raw-sql.md b/...uides/add-custom-functionality/raw-sql.md → ...uides/add-custom-functionality/raw-sql.md
diff --git a/....3/guides/applications-with-stackables.md → ....0/guides/applications-with-stackables.md b/....3/guides/applications-with-stackables.md → ....0/guides/applications-with-stackables.md
@@ -12,7 +12,7 @@ This process is the same one we use to maintain Platformatic DB and Platformatic
 
 ## Creating a custom Service
 
-We are creating the module `foo.js` as follows: 
+We are creating the stackable `foo.js` as follows: 
 
 ```js
 const { schema, platformaticService } = require('@platformatic/service')
@@ -51,7 +51,7 @@ foo.schema = {
     $schema: {
       type: 'string'
     },
-    module: {
+    extends: {
       type: 'string'
     },
     foo: {
@@ -102,7 +102,7 @@ Consuming `foo.js` is simple. We can create a `platformatic.json` file as follow
 ```json
 {
   "$schema": "https://example.com/schemas/foo.json",
-  "module": "./foo",
+  "extends": "./foo",
   "server": {
     "port": 0,
     "hostname": "127.0.0.1"
@@ -113,11 +113,12 @@ Consuming `foo.js` is simple. We can create a `platformatic.json` file as follow
 }
 ```
 
-Note that we __must__ specify both the `$schema` property and `module`.
-Module can also be any modules published on npm and installed via your package manager.
+Note that we __must__ specify both the `$schema` property and `extends`.
+The module specified with `extends` can also be any modules published on npm and installed via your package manager.
 
 :::note
-The `module` is the name of the module we are actually "stacking" on top of.
+`extends` is the name of the module we are actually "stacking" (extending) on top of. 
+The property `module` can also be used, but it is deprecated. In both cases, be sure that the property is allowed in the stackable schema (in this example in `foo.schema`)
 :::
 
 ## Building your own CLI