wip: update doc for v2

0cwa · Jun 20, 2021 · 6c69b70 · 6c69b70
1 parent e07f8e2
commit 6c69b70
Show file tree

Hide file tree

Showing 30 changed files with 155 additions and 531 deletions.
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/scripts/generate/templates/_partials/_qovery_deploy_app_web.md.erb b/scripts/generate/templates/_partials/_qovery_deploy_app_web.md.erb
@@ -2,11 +2,7 @@ Here is a short video showing how to deploy your app with the [Qovery Web interf
 
 <div class="video-container">
   <p align="center">
-    <iframe width="800" height="600" src="https://www.youtube.com/embed/kdCt26vyzgs" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
+    <iframe src="https://www.loom.com/embed/c48c2e6351a3461482151bd0138e5a5e" width="100%" height="100%" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen>
     </iframe>
   </p>
 </div>
-
-Steps:
-* Create a project
-* Deploy an app
diff --git a/scripts/generate/templates/_partials/_qovery_summary.md.erb b/scripts/generate/templates/_partials/_qovery_summary.md.erb
@@ -17,21 +17,18 @@ your applications in the Cloud.
 Setup your [AWS][docs.using-qovery.configuration.cloud-service-provider.amazon-web-services]
 , [Digital Ocean][docs.using-qovery.configuration.cloud-service-provider.digital-ocean]
 and [Scaleway][docs.using-qovery.configuration.cloud-service-provider.scaleway] account.
-
 <p align="center">
   <img src="/img/cloud_service_providers_view.svg" alt="Deploy on your AWS, Digital Ocean and Scaleway account with Qovery" />
 </p>
 
 2. ### Connect your Git repository
 Qovery is fully integrated into Github, Gitlab, and Bitbucket.
-
 <p align="center">
   <img src="/img/connect_git_repository.svg" alt="Connect your Github repository" />
 </p>
 
 3. ### Your app is deployed
 Your application is up and running instantly
-
 <p align="center">
   <img src="/img/environment_deployed.svg" alt="Your Qovery environment is up and running" />
 </p>

diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md
@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-04-22"
+last_modified_on: "2021-06-20"
 title: Getting started
 description: "About Qovery, the platform that accelerates and scales application development cycle with zero infrastructure management investment."
 sidebar_label: hidden
@@ -10,10 +10,10 @@ import Jump from '@site/src/components/Jump';
 
 This section covers the basic concepts of Qovery and provides a foundation for the rest of the documentation.
 
-<Jump to="/docs/getting-started/what-is-qovery/">What is Qovery?</Jump>
-<Jump to="/docs/getting-started/how-qovery-works/">How Qovery Works?</Jump>
-<Jump to="/docs/getting-started/quickstart/">Quickstart</Jump>
-<Jump to="/docs/getting-started/whats-next/">What's next?</Jump>
+<Jump to="/docs/getting-started/features/">Features</Jump>
+<Jump to="/docs/getting-started/qovery-vs-other/">Qovery vs other</Jump>
+<Jump to="/docs/getting-started/what-is-qovery/">What is qovery</Jump>
+<Jump to="/docs/getting-started/whats-next/">Whats next</Jump>
 
 
 
diff --git a/website/docs/getting-started.md.erb b/website/docs/getting-started.md.erb
@@ -7,7 +7,4 @@ hide_pagination: true
 
 This section covers the basic concepts of Qovery and provides a foundation for the rest of the documentation.
 
-<Jump to="/docs/getting-started/what-is-qovery/">What is Qovery?</Jump>
-<Jump to="/docs/getting-started/how-qovery-works/">How Qovery Works?</Jump>
-<Jump to="/docs/getting-started/quickstart/">Quickstart</Jump>
-<Jump to="/docs/getting-started/whats-next/">What's next?</Jump>
+<%= subpages() %>
diff --git a/website/docs/getting-started/what-is-qovery.md b/website/docs/getting-started/what-is-qovery.md
@@ -34,21 +34,18 @@ your applications in the Cloud.
 Setup your [AWS][docs.using-qovery.configuration.cloud-service-provider.amazon-web-services]
 , [Digital Ocean][docs.using-qovery.configuration.cloud-service-provider.digital-ocean]
 and [Scaleway][docs.using-qovery.configuration.cloud-service-provider.scaleway] account.
-
 <p align="center">
   <img src="/img/cloud_service_providers_view.svg" alt="Deploy on your AWS, Digital Ocean and Scaleway account with Qovery" />
 </p>
 
 2. ### Connect your Git repository
 Qovery is fully integrated into Github, Gitlab, and Bitbucket.
-
 <p align="center">
   <img src="/img/connect_git_repository.svg" alt="Connect your Github repository" />
 </p>
 
 3. ### Your app is deployed
 Your application is up and running instantly
-
 <p align="center">
   <img src="/img/environment_deployed.svg" alt="Your Qovery environment is up and running" />
 </p>

diff --git a/website/docs/security-and-compliance.md b/website/docs/security-and-compliance.md
@@ -1,5 +1,5 @@
 ---
-last_modified_on: "2020-04-23"
+last_modified_on: "2021-06-20"
 title: Security and Compliance
 description: "Learn more about Security and Compliance in Qovery"
 sidebar_label: hidden
@@ -10,9 +10,9 @@ import Jump from '@site/src/components/Jump';
 
 This section will cover the main Security and Compliance topics:
 
-<Jump to="/docs/security-and-compliance/backup-and-restore/">Backup and Restore</Jump>
+<Jump to="/docs/security-and-compliance/backup-and-restore/">Backup and restore</Jump>
 <Jump to="/docs/security-and-compliance/encryption/">Encryption</Jump>
-<Jump to="/docs/security-and-compliance/gdpr/">GDPR</Jump>
+<Jump to="/docs/security-and-compliance/gdpr/">Gdpr</Jump>
 
 
 
diff --git a/website/docs/security-and-compliance.md.erb b/website/docs/security-and-compliance.md.erb
@@ -7,6 +7,4 @@ hide_pagination: true
 
 This section will cover the main Security and Compliance topics:
 
-<Jump to="/docs/security-and-compliance/backup-and-restore/">Backup and Restore</Jump>
-<Jump to="/docs/security-and-compliance/encryption/">Encryption</Jump>
-<Jump to="/docs/security-and-compliance/gdpr/">GDPR</Jump>
+<%= subpages() %>
diff --git a/website/docs/using-qovery/addon.md b/website/docs/using-qovery/addon.md
@@ -10,9 +10,12 @@ import Jump from '@site/src/components/Jump';
 
 Qovery integrations improve developers' experience with Qovery and make their lives easier.
 
-This section shows several Qovery integrations. Some of them are maintained by the Qovery community and [open sourced][urls.main_qovery_github].
+This section shows several Qovery addons.
+
+<Jump to="/docs/using-qovery/addon/container-registry/">Container registry</Jump>
+<Jump to="/docs/using-qovery/addon/continuous-integration/">Continuous integration</Jump>
+<Jump to="/docs/using-qovery/addon/github-preview/">Github preview</Jump>
+<Jump to="/docs/using-qovery/addon/monitoring/">Monitoring</Jump>
 
-<Jump to="/docs/using-qovery/addon/">Addons</Jump>
 
 
-[urls.main_qovery_github]: https://github.com/qovery
diff --git a/website/docs/using-qovery/addon.md.erb b/website/docs/using-qovery/addon.md.erb
@@ -6,6 +6,6 @@ hide_pagination: true
 ---
 Qovery integrations improve developers' experience with Qovery and make their lives easier.
 
-This section shows several Qovery integrations. Some of them are maintained by the Qovery community and [open sourced][urls.main_qovery_github].
+This section shows several Qovery addons.
 
-<Jump to="/docs/using-qovery/addon/">Addons</Jump>
+<%= subpages() %>
diff --git a/website/docs/using-qovery/configuration.md b/website/docs/using-qovery/configuration.md
@@ -10,18 +10,19 @@ import Jump from '@site/src/components/Jump';
 
 In the following subsections, you'll learn all you need to know to configure and deploy your apps on Qovery.
 
-<Jump to="/docs/using-qovery/configuration/organization/">Organization</Jump>
-<Jump to="/docs/using-qovery/configuration/project/">Project</Jump>
-<Jump to="/docs/using-qovery/configuration/environment/">Environment</Jump>
 <Jump to="/docs/using-qovery/configuration/application/">Application</Jump>
+<Jump to="/docs/using-qovery/configuration/cloud-service-provider/">Cloud service provider</Jump>
 <Jump to="/docs/using-qovery/configuration/database/">Database</Jump>
-<Jump to="/docs/using-qovery/configuration/environment-variable/">Environment Variable</Jump>
-<Jump to="/docs/using-qovery/configuration/secret/">Secret</Jump>
+<Jump to="/docs/using-qovery/configuration/deployment-rule/">Deployment rule</Jump>
 <Jump to="/docs/using-qovery/configuration/domain/">Domain</Jump>
-<Jump to="/docs/using-qovery/configuration/storage/">Storage</Jump>
+<Jump to="/docs/using-qovery/configuration/environment-variable/">Environment variable</Jump>
+<Jump to="/docs/using-qovery/configuration/environment/">Environment</Jump>
+<Jump to="/docs/using-qovery/configuration/external-service/">External service</Jump>
+<Jump to="/docs/using-qovery/configuration/organization/">Organization</Jump>
+<Jump to="/docs/using-qovery/configuration/project/">Project</Jump>
 <Jump to="/docs/using-qovery/configuration/routing/">Routing</Jump>
-<Jump to="/docs/using-qovery/configuration/deployment-rule/">Deployment rule</Jump>
-<Jump to="/docs/using-qovery/configuration/cloud-service-provider/">Cloud Service Provider</Jump>
+<Jump to="/docs/using-qovery/configuration/secret/">Secret</Jump>
+<Jump to="/docs/using-qovery/configuration/storage/">Storage</Jump>
 
 
 
diff --git a/website/docs/using-qovery/configuration.md.erb b/website/docs/using-qovery/configuration.md.erb
@@ -6,15 +6,4 @@ hide_pagination: true
 ---
 In the following subsections, you'll learn all you need to know to configure and deploy your apps on Qovery.
 
-<Jump to="/docs/using-qovery/configuration/organization/">Organization</Jump>
-<Jump to="/docs/using-qovery/configuration/project/">Project</Jump>
-<Jump to="/docs/using-qovery/configuration/environment/">Environment</Jump>
-<Jump to="/docs/using-qovery/configuration/application/">Application</Jump>
-<Jump to="/docs/using-qovery/configuration/database/">Database</Jump>
-<Jump to="/docs/using-qovery/configuration/environment-variable/">Environment Variable</Jump>
-<Jump to="/docs/using-qovery/configuration/secret/">Secret</Jump>
-<Jump to="/docs/using-qovery/configuration/domain/">Domain</Jump>
-<Jump to="/docs/using-qovery/configuration/storage/">Storage</Jump>
-<Jump to="/docs/using-qovery/configuration/routing/">Routing</Jump>
-<Jump to="/docs/using-qovery/configuration/deployment-rule/">Deployment rule</Jump>
-<Jump to="/docs/using-qovery/configuration/cloud-service-provider/">Cloud Service Provider</Jump>
+<%= subpages() %>
diff --git a/website/docs/using-qovery/configuration/project.md b/website/docs/using-qovery/configuration/project.md
@@ -7,6 +7,12 @@ import Jump from '@site/src/components/Jump';
 
 A project allows you to group a set of applications and their dependencies (databases & other services).
 
+<Assumptions>
+
+* You have created an [organization][docs.using-qovery.configuration.organization]
+
+</Assumptions>
+
 <!--
      THIS FILE IS AUTOGENERATED!
 
@@ -17,15 +23,21 @@ A project allows you to group a set of applications and their dependencies (data
 
 ## Create a project
 
-TODO
+<p align="center">
+  <img src="/img/qovery_empty_state_project_list.png" alt="Qovery - project list with empty state" />
+</p>
+
+To create a project you simply need to provide a name. It is also possible to provide a description afterwards.
 
 ### Demo project
 
-TODO
+If you have no project to deploy but still want to give a try to Qovery, you can create a demo project.
 
 ## Delete a project
 
-TODO
-
+<p align="center">
+  <img src="/img/delete_project.png" alt="Qovery - delete a project" />
+</p>
 
 
+[docs.using-qovery.configuration.organization]: /docs/using-qovery/configuration/organization/
diff --git a/website/docs/using-qovery/configuration/project.md.erb b/website/docs/using-qovery/configuration/project.md.erb
@@ -6,14 +6,26 @@ import Jump from '@site/src/components/Jump';
 
 A project allows you to group a set of applications and their dependencies (databases & other services).
 
+<Assumptions>
+
+* You have created an [organization][docs.using-qovery.configuration.organization]
+
+</Assumptions>
+
 ## Create a project
 
-TODO
+<p align="center">
+  <img src="/img/qovery_empty_state_project_list.png" alt="Qovery - project list with empty state" />
+</p>
+
+To create a project you simply need to provide a name. It is also possible to provide a description afterwards.
 
 ### Demo project
 
-TODO
+If you have no project to deploy but still want to give a try to Qovery, you can create a demo project.
 
 ## Delete a project
 
-TODO
+<p align="center">
+  <img src="/img/delete_project.png" alt="Qovery - delete a project" />
+</p>
diff --git a/website/docs/using-qovery/interface.md b/website/docs/using-qovery/interface.md
@@ -10,8 +10,8 @@ import Jump from '@site/src/components/Jump';
 
 In the following subsections, you'll learn how to use the web interface, and the  CLI (Command Line Interface) to deploy your application with Qovery.
 
+<Jump to="/docs/using-qovery/interface/cli/">Cli</Jump>
 <Jump to="/docs/using-qovery/interface/web-interface/">Web interface</Jump>
-<Jump to="/docs/using-qovery/interface/cli/">CLIs</Jump>
 
 
 
diff --git a/website/docs/using-qovery/interface.md.erb b/website/docs/using-qovery/interface.md.erb
@@ -6,5 +6,5 @@ hide_pagination: true
 ---
 In the following subsections, you'll learn how to use the web interface, and the  CLI (Command Line Interface) to deploy your application with Qovery.
 
-<Jump to="/docs/using-qovery/interface/web-interface/">Web interface</Jump>
-<Jump to="/docs/using-qovery/interface/cli/">CLIs</Jump>
+<%= subpages() %>
+
diff --git a/website/docs/using-qovery/quickstart.md b/website/docs/using-qovery/quickstart.md
@@ -5,7 +5,12 @@ description: "Quickstart to deploy your project with Qovery"
 sidebar_label: hidden
 hide_pagination: true
 ---
+
+import Jump from '@site/src/components/Jump';
+
 In the following subsections, you'll learn how to deploy your application with Qovery.
 
+<Jump to="/docs/using-qovery/quickstart/strapi/">Strapi</Jump>
+
 
 
diff --git a/website/docs/using-qovery/quickstart.md.erb b/website/docs/using-qovery/quickstart.md.erb
@@ -6,3 +6,4 @@ hide_pagination: true
 ---
 In the following subsections, you'll learn how to deploy your application with Qovery.
 
+<%= subpages() %>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@ hide_pagination: true
		---
		In the following subsections, you'll learn how to deploy your application with Qovery.

		<%= subpages() %>