From 9e1928a9322a24fe275f6657c786cd695d0863fb Mon Sep 17 00:00:00 2001 From: Sam Alba Date: Wed, 9 Jun 2021 16:27:24 +0200 Subject: [PATCH] docs: changed layout to be closer to the final one Signed-off-by: Sam Alba --- docs/administrator/_category_.json | 4 ++++ docs/{guides => administrator}/operator.md | 0 docs/introduction/_category_.json | 4 ++++ docs/{ => introduction}/vs.md | 14 +++++++------- docs/{README.md => introduction/what_is.md} | 2 +- docs/programming/_category_.json | 4 ++++ docs/{ => programming}/guides/_category_.json | 2 +- docs/{guides => programming}/programming.md | 2 +- docs/reference/_category_.json | 2 +- docs/user/_category_.json | 4 ++++ docs/user/user.md | 9 +++++++++ 11 files changed, 36 insertions(+), 11 deletions(-) create mode 100644 docs/administrator/_category_.json rename docs/{guides => administrator}/operator.md (100%) create mode 100644 docs/introduction/_category_.json rename docs/{ => introduction}/vs.md (85%) rename docs/{README.md => introduction/what_is.md} (97%) create mode 100644 docs/programming/_category_.json rename docs/{ => programming}/guides/_category_.json (60%) rename docs/{guides => programming}/programming.md (99%) create mode 100644 docs/user/_category_.json create mode 100644 docs/user/user.md diff --git a/docs/administrator/_category_.json b/docs/administrator/_category_.json new file mode 100644 index 00000000..d5618c12 --- /dev/null +++ b/docs/administrator/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Administrator Manual", + "position": 6 +} diff --git a/docs/guides/operator.md b/docs/administrator/operator.md similarity index 100% rename from docs/guides/operator.md rename to docs/administrator/operator.md diff --git a/docs/introduction/_category_.json b/docs/introduction/_category_.json new file mode 100644 index 00000000..fa1c06ac --- /dev/null +++ b/docs/introduction/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Introduction", + "position": 1 +} diff --git a/docs/vs.md b/docs/introduction/vs.md similarity index 85% rename from docs/vs.md rename to docs/introduction/vs.md index 928f7905..68d68946 100644 --- a/docs/vs.md +++ b/docs/introduction/vs.md @@ -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. diff --git a/docs/README.md b/docs/introduction/what_is.md similarity index 97% rename from docs/README.md rename to docs/introduction/what_is.md index a1c8ebd1..553aced4 100644 --- a/docs/README.md +++ b/docs/introduction/what_is.md @@ -1,7 +1,7 @@ --- sidebar_position: 1 slug: / -sidebar_label: Introduction +sidebar_label: What is Dagger? --- # Dagger diff --git a/docs/programming/_category_.json b/docs/programming/_category_.json new file mode 100644 index 00000000..ff7ecfb9 --- /dev/null +++ b/docs/programming/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Programming Manual", + "position": 4 +} diff --git a/docs/guides/_category_.json b/docs/programming/guides/_category_.json similarity index 60% rename from docs/guides/_category_.json rename to docs/programming/guides/_category_.json index b6d47724..137f6d06 100644 --- a/docs/guides/_category_.json +++ b/docs/programming/guides/_category_.json @@ -1,4 +1,4 @@ { "label": "Guides", - "position": 4 + "position": 1 } diff --git a/docs/guides/programming.md b/docs/programming/programming.md similarity index 99% rename from docs/guides/programming.md rename to docs/programming/programming.md index d9875f2c..e20d0aeb 100644 --- a/docs/guides/programming.md +++ b/docs/programming/programming.md @@ -3,7 +3,7 @@ sidebar_position: 1 slug: /programming --- -# Dagger Programming Guide +# Programming ## Writing your first Dagger plan diff --git a/docs/reference/_category_.json b/docs/reference/_category_.json index 1b337d5a..a1d3ffeb 100644 --- a/docs/reference/_category_.json +++ b/docs/reference/_category_.json @@ -1,4 +1,4 @@ { - "label": "Reference", + "label": "API Reference", "position": 5 } diff --git a/docs/user/_category_.json b/docs/user/_category_.json new file mode 100644 index 00000000..f902040b --- /dev/null +++ b/docs/user/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "User Manual", + "position": 3 +} diff --git a/docs/user/user.md b/docs/user/user.md new file mode 100644 index 00000000..e72480e2 --- /dev/null +++ b/docs/user/user.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +slug: /user +sidebar_label: User Manual +--- + +# User Manual + +TODO