Merge pull request #597 from samalba/docs-layout

docs: changed layout to be closer to the final one
This commit is contained in:
Sam Alba 2021-06-09 16:35:11 +02:00 committed by GitHub
commit d592d66e24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 36 additions and 11 deletions

View File

@ -0,0 +1,4 @@
{
"label": "Administrator Manual",
"position": 6
}

View File

@ -0,0 +1,4 @@
{
"label": "Introduction",
"position": 1
}

View File

@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 2
slug: /vs
sidebar_label: Dagger vs. Other software
---
@ -8,18 +8,18 @@ sidebar_label: Dagger vs. Other software
## Dagger vs. PaaS (Heroku, Firebase, etc.)
*Summary: Dagger can be used with or without a PaaS system.*
_Summary: Dagger can be used with or without a PaaS system._
A PaaS system is a complete platform for deploying and running certain types of applications.
* The benefit of using a PaaS system is convenience: developers don't have to worry about the many details of deployment: everything just works.
* The drawback of using a PaaS system is lack of flexibility: only certain types of applications are supported.
- The benefit of using a PaaS system is convenience: developers don't have to worry about the many details of deployment: everything just works.
- The drawback of using a PaaS system is lack of flexibility: only certain types of applications are supported.
As an application grows, it is almost certain to outgrow the capabilities of a PaaS system, leaving no choice but to look for alternatives. A good strategy is to choose the right platform for each component. Some components continue to run on a PaaS system; others run on specialized infrastructure. This strategy can be implemented with Dagger: each component gets its own deployment plan expressed as code, and Dagger glues it all together into a single workflow.
## Dagger vs. artisanal deploy scripts
*Summary: Dagger can augment your deploy scripts, and later help you simplify or even remove them.*
_Summary: Dagger can augment your deploy scripts, and later help you simplify or even remove them._
Most applications don't fit entirely in any major PaaS system. Instead they are deployed by a patchwork of tools, usually glued together by an artisanal script.
@ -31,14 +31,14 @@ Dagger can either replace artisanal deploy scripts altogether, or augment them b
## Dagger vs. CI (Github Actions, Gitlab, CircleCI, Jenkins, etc.)
*Summary: Dagger can be used with or without a CI system.*
_Summary: Dagger can be used with or without a CI system._
Dagger is not a replacement for a CI system. It can be used to deploy applications directly from the terminal,
or automatically as part of a CI script.
## Dagger vs. Build Systems (Make, Maven, Bazel, Npm/Yarn, etc.)
*Summary: Dagger can be used with or without a build system.*
_Summary: Dagger can be used with or without a build system._
Most deployment workflows involve building: the process of producing executable artifacts from source code. Build systems are highly specific to the type of application, the programming language in use, etc.

View File

@ -1,7 +1,7 @@
---
sidebar_position: 1
slug: /
sidebar_label: Introduction
sidebar_label: What is Dagger?
---
# Dagger

View File

@ -0,0 +1,4 @@
{
"label": "Programming Manual",
"position": 4
}

View File

@ -1,4 +1,4 @@
{
"label": "Guides",
"position": 4
"position": 1
}

View File

@ -3,7 +3,7 @@ sidebar_position: 1
slug: /programming
---
# Dagger Programming Guide
# Programming
## Writing your first Dagger plan

View File

@ -1,4 +1,4 @@
{
"label": "Reference",
"label": "API Reference",
"position": 5
}

View File

@ -0,0 +1,4 @@
{
"label": "User Manual",
"position": 3
}

9
docs/user/user.md Normal file
View File

@ -0,0 +1,9 @@
---
sidebar_position: 1
slug: /user
sidebar_label: User Manual
---
# User Manual
TODO