From 57754bebb864341f30aa6f81a57735d45356a385 Mon Sep 17 00:00:00 2001 From: Solomon Hykes Date: Fri, 16 Jul 2021 16:37:29 +0000 Subject: [PATCH] "kb style" docs: decouple URLs from structure Signed-off-by: Solomon Hykes --- docs/{install.md => 1001-install.md} | 2 +- docs/{introduction/vs.md => 1002-vs.md} | 2 +- docs/{learn/101-use.md => 1003-get-started.md} | 4 ++-- docs/{learn/102-dev.md => 1004-first-env.md} | 4 ++-- docs/{learn/103-script.md => 1005-custom-script.md} | 4 ++-- docs/{learn/106-cloudrun.md => 1006-google-cloud-run.md} | 4 ++-- docs/{learn/107-kubernetes.md => 1007-kubernetes.md} | 4 ++-- .../108-cloudformation.md => 1008-aws-cloudformation.md} | 4 ++-- .../{learn/109-github-actions.md => 1009-github-actions.md} | 6 +++++- docs/{learn/109-packages.md => 1010-dev-cue-package.md} | 6 +++++- docs/{administrator/operator.md => 1011-operator-manual.md} | 4 ++++ docs/administrator/1011-operator-manual.md | 1 + docs/introduction/1002-vs.md | 1 + docs/learn/1003-get-started.md | 1 + docs/learn/1004-first-env.md | 1 + docs/learn/1005-custom-script.md | 1 + docs/learn/1006-google-cloud-run.md | 1 + docs/learn/1007-kubernetes.md | 1 + docs/learn/1008-aws-cloudformation.md | 1 + docs/learn/1009-github-actions.md | 1 + docs/learn/1010-dev-cue-package.md | 1 + 21 files changed, 38 insertions(+), 16 deletions(-) rename docs/{install.md => 1001-install.md} (98%) rename docs/{introduction/vs.md => 1002-vs.md} (99%) rename docs/{learn/101-use.md => 1003-get-started.md} (98%) rename docs/{learn/102-dev.md => 1004-first-env.md} (99%) rename docs/{learn/103-script.md => 1005-custom-script.md} (89%) rename docs/{learn/106-cloudrun.md => 1006-google-cloud-run.md} (97%) rename docs/{learn/107-kubernetes.md => 1007-kubernetes.md} (99%) rename docs/{learn/108-cloudformation.md => 1008-aws-cloudformation.md} (99%) rename docs/{learn/109-github-actions.md => 1009-github-actions.md} (95%) rename docs/{learn/109-packages.md => 1010-dev-cue-package.md} (98%) rename docs/{administrator/operator.md => 1011-operator-manual.md} (97%) create mode 120000 docs/administrator/1011-operator-manual.md create mode 120000 docs/introduction/1002-vs.md create mode 120000 docs/learn/1003-get-started.md create mode 120000 docs/learn/1004-first-env.md create mode 120000 docs/learn/1005-custom-script.md create mode 120000 docs/learn/1006-google-cloud-run.md create mode 120000 docs/learn/1007-kubernetes.md create mode 120000 docs/learn/1008-aws-cloudformation.md create mode 120000 docs/learn/1009-github-actions.md create mode 120000 docs/learn/1010-dev-cue-package.md diff --git a/docs/install.md b/docs/1001-install.md similarity index 98% rename from docs/install.md rename to docs/1001-install.md index c489039a..cfa0c21d 100644 --- a/docs/install.md +++ b/docs/1001-install.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -slug: /install +slug: /1001/install/ --- # Install Dagger diff --git a/docs/introduction/vs.md b/docs/1002-vs.md similarity index 99% rename from docs/introduction/vs.md rename to docs/1002-vs.md index a970077a..214fcfe3 100644 --- a/docs/introduction/vs.md +++ b/docs/1002-vs.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -slug: /vs +slug: /1002/vs/ --- # Dagger vs. Other Software diff --git a/docs/learn/101-use.md b/docs/1003-get-started.md similarity index 98% rename from docs/learn/101-use.md rename to docs/1003-get-started.md index ec8b052e..01449dc6 100644 --- a/docs/learn/101-use.md +++ b/docs/1003-get-started.md @@ -1,8 +1,8 @@ --- -slug: /learn/101-basics +slug: /1003/get-started/ --- -# Dagger 101: basic usage +# Get started with Dagger In this guide, you will learn the basics of Dagger by interacting with a pre-configured environment. Then you will move on to creating your environment from scratch. diff --git a/docs/learn/102-dev.md b/docs/1004-first-env.md similarity index 99% rename from docs/learn/102-dev.md rename to docs/1004-first-env.md index 516e11d1..11b31665 100644 --- a/docs/learn/102-dev.md +++ b/docs/1004-first-env.md @@ -1,8 +1,8 @@ --- -slug: /learn/102-dev +slug: /1004/dev-first-env/ --- -# Dagger 102: create your first environment +# Create your first Dagger environment ## Overview diff --git a/docs/learn/103-script.md b/docs/1005-custom-script.md similarity index 89% rename from docs/learn/103-script.md rename to docs/1005-custom-script.md index 066d1bb4..64041ffe 100644 --- a/docs/learn/103-script.md +++ b/docs/1005-custom-script.md @@ -1,8 +1,8 @@ --- -slug: /learn/103-script +slug: /1005/custom-script/ --- -# Dagger 103: integrate custom shell scripts +# Integrate custom shell scripts In this guide, you will learn how to incorporate your custom shell scripts into a Dagger environment. For example, run integration tests before deployment; call a custom processing step; or any other custom task which you have already automated and want to incorporate into your Dagger environment with minimal effort. diff --git a/docs/learn/106-cloudrun.md b/docs/1006-google-cloud-run.md similarity index 97% rename from docs/learn/106-cloudrun.md rename to docs/1006-google-cloud-run.md index 12b41bdb..071e101e 100644 --- a/docs/learn/106-cloudrun.md +++ b/docs/1006-google-cloud-run.md @@ -1,8 +1,8 @@ --- -slug: /learn/106-cloudrun +slug: /1006/google-cloud-run/ --- -# Dagger 106: deploy to Cloud Run +# Deploy to Google Cloud Run with Dagger This tutorial illustrates how to use Dagger to build, push and deploy Docker images to Cloud Run. diff --git a/docs/learn/107-kubernetes.md b/docs/1007-kubernetes.md similarity index 99% rename from docs/learn/107-kubernetes.md rename to docs/1007-kubernetes.md index da03a834..eaaf13f7 100644 --- a/docs/learn/107-kubernetes.md +++ b/docs/1007-kubernetes.md @@ -1,8 +1,8 @@ --- -slug: /learn/107-kubernetes +slug: /1007/kubernetes/ --- -# Dagger 107: deploy to Kubernetes +# Deploy to Kubernetes with Dagger This tutorial illustrates how to use Dagger to build, push and deploy Docker images to Kubernetes. diff --git a/docs/learn/108-cloudformation.md b/docs/1008-aws-cloudformation.md similarity index 99% rename from docs/learn/108-cloudformation.md rename to docs/1008-aws-cloudformation.md index 6540f21f..24e84871 100644 --- a/docs/learn/108-cloudformation.md +++ b/docs/1008-aws-cloudformation.md @@ -1,8 +1,8 @@ --- -slug: /learn/108-cloudformation +slug: /1008/aws-cloudformation/ --- -# Dagger 108: provision infrastructure on AWS +# Provision infrastructure with Dagger and AWS CloudFormation In this guide, you will learn how to automatically [provision infrastructure](https://dzone.com/articles/infrastructure-provisioning-–) on AWS by integrating [Amazon Cloudformation](https://aws.amazon.com/cloudformation/) in your Dagger environment. diff --git a/docs/learn/109-github-actions.md b/docs/1009-github-actions.md similarity index 95% rename from docs/learn/109-github-actions.md rename to docs/1009-github-actions.md index 83eb254f..5147f84c 100644 --- a/docs/learn/109-github-actions.md +++ b/docs/1009-github-actions.md @@ -1,4 +1,8 @@ -# Dagger 109: integrate with Github Actions +--- +slug: /1009/github-actions/ +--- + +# Integrate Dagger with Github Actions This tutorial illustrates how to use Github Actions and Dagger to build, push and deploy Docker images to Cloud Run. diff --git a/docs/learn/109-packages.md b/docs/1010-dev-cue-package.md similarity index 98% rename from docs/learn/109-packages.md rename to docs/1010-dev-cue-package.md index b0817373..86729bf9 100644 --- a/docs/learn/109-packages.md +++ b/docs/1010-dev-cue-package.md @@ -1,4 +1,8 @@ -# Dagger 109: creating packages +--- +slug: /1010/dev-cue-package/ +--- + +# Develop a new CUE package for Dagger This tutorial illustrates how to create new packages, manually distribute them among your applications and contribute to the Dagger stdlib packages. diff --git a/docs/administrator/operator.md b/docs/1011-operator-manual.md similarity index 97% rename from docs/administrator/operator.md rename to docs/1011-operator-manual.md index c25e2f1f..c3d4d6bf 100644 --- a/docs/administrator/operator.md +++ b/docs/1011-operator-manual.md @@ -1,3 +1,7 @@ +--- +slug: /1011/operator-manual/ +--- + # Dagger Operator Manual ## Custom buildkit setup diff --git a/docs/administrator/1011-operator-manual.md b/docs/administrator/1011-operator-manual.md new file mode 120000 index 00000000..f5090e72 --- /dev/null +++ b/docs/administrator/1011-operator-manual.md @@ -0,0 +1 @@ +../1011-operator-manual.md \ No newline at end of file diff --git a/docs/introduction/1002-vs.md b/docs/introduction/1002-vs.md new file mode 120000 index 00000000..4f16eced --- /dev/null +++ b/docs/introduction/1002-vs.md @@ -0,0 +1 @@ +../1002-vs.md \ No newline at end of file diff --git a/docs/learn/1003-get-started.md b/docs/learn/1003-get-started.md new file mode 120000 index 00000000..af98e6f5 --- /dev/null +++ b/docs/learn/1003-get-started.md @@ -0,0 +1 @@ +../1003-get-started.md \ No newline at end of file diff --git a/docs/learn/1004-first-env.md b/docs/learn/1004-first-env.md new file mode 120000 index 00000000..b51076de --- /dev/null +++ b/docs/learn/1004-first-env.md @@ -0,0 +1 @@ +../1004-first-env.md \ No newline at end of file diff --git a/docs/learn/1005-custom-script.md b/docs/learn/1005-custom-script.md new file mode 120000 index 00000000..51b7f4e0 --- /dev/null +++ b/docs/learn/1005-custom-script.md @@ -0,0 +1 @@ +../1005-custom-script.md \ No newline at end of file diff --git a/docs/learn/1006-google-cloud-run.md b/docs/learn/1006-google-cloud-run.md new file mode 120000 index 00000000..315b0ad3 --- /dev/null +++ b/docs/learn/1006-google-cloud-run.md @@ -0,0 +1 @@ +../1006-google-cloud-run.md \ No newline at end of file diff --git a/docs/learn/1007-kubernetes.md b/docs/learn/1007-kubernetes.md new file mode 120000 index 00000000..5d3ac89a --- /dev/null +++ b/docs/learn/1007-kubernetes.md @@ -0,0 +1 @@ +../1007-kubernetes.md \ No newline at end of file diff --git a/docs/learn/1008-aws-cloudformation.md b/docs/learn/1008-aws-cloudformation.md new file mode 120000 index 00000000..4c749e3c --- /dev/null +++ b/docs/learn/1008-aws-cloudformation.md @@ -0,0 +1 @@ +../1008-aws-cloudformation.md \ No newline at end of file diff --git a/docs/learn/1009-github-actions.md b/docs/learn/1009-github-actions.md new file mode 120000 index 00000000..c5dbe68f --- /dev/null +++ b/docs/learn/1009-github-actions.md @@ -0,0 +1 @@ +../1009-github-actions.md \ No newline at end of file diff --git a/docs/learn/1010-dev-cue-package.md b/docs/learn/1010-dev-cue-package.md new file mode 120000 index 00000000..1af3d9e6 --- /dev/null +++ b/docs/learn/1010-dev-cue-package.md @@ -0,0 +1 @@ +../1010-dev-cue-package.md \ No newline at end of file