From 7364951e95f88ce551233cb2572c6be628ade10e Mon Sep 17 00:00:00 2001 From: Andrea Luzzardi Date: Fri, 8 Oct 2021 16:18:02 -0700 Subject: [PATCH 1/2] docs: define sidebar manually Signed-off-by: Andrea Luzzardi --- docs/1001-install.md | 1 - docs/administrator/_category_.json | 5 --- docs/introduction/1002-vs.md | 1 - docs/introduction/_category_.json | 5 --- docs/introduction/what_is.md | 2 - docs/learn/1005-what_is_cue.md | 30 +++++++-------- docs/learn/_category_.json | 5 --- docs/reference/_category_.json | 5 --- docs/use-cases/_category_.json | 5 --- website/sidebars.js | 60 ++++++++++++++++++++++++------ 10 files changed, 63 insertions(+), 56 deletions(-) delete mode 100644 docs/administrator/_category_.json delete mode 100644 docs/introduction/_category_.json delete mode 100644 docs/learn/_category_.json delete mode 100644 docs/reference/_category_.json delete mode 100644 docs/use-cases/_category_.json diff --git a/docs/1001-install.md b/docs/1001-install.md index 88ad7810..279b3ae6 100644 --- a/docs/1001-install.md +++ b/docs/1001-install.md @@ -1,5 +1,4 @@ --- -sidebar_position: 2 slug: /1001/install/ --- diff --git a/docs/administrator/_category_.json b/docs/administrator/_category_.json deleted file mode 100644 index 86f89975..00000000 --- a/docs/administrator/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Administrator Manual", - "position": 6, - "collapsed": false -} diff --git a/docs/introduction/1002-vs.md b/docs/introduction/1002-vs.md index 214fcfe3..100b231d 100644 --- a/docs/introduction/1002-vs.md +++ b/docs/introduction/1002-vs.md @@ -1,5 +1,4 @@ --- -sidebar_position: 2 slug: /1002/vs/ --- diff --git a/docs/introduction/_category_.json b/docs/introduction/_category_.json deleted file mode 100644 index 096f399e..00000000 --- a/docs/introduction/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Introduction", - "position": 1, - "collapsed": false -} diff --git a/docs/introduction/what_is.md b/docs/introduction/what_is.md index 9e74327e..29812e7d 100644 --- a/docs/introduction/what_is.md +++ b/docs/introduction/what_is.md @@ -1,7 +1,5 @@ --- -sidebar_position: 1 slug: / -sidebar_label: What is Dagger? --- # What is Dagger? diff --git a/docs/learn/1005-what_is_cue.md b/docs/learn/1005-what_is_cue.md index 74c301ed..557718ed 100644 --- a/docs/learn/1005-what_is_cue.md +++ b/docs/learn/1005-what_is_cue.md @@ -1,7 +1,5 @@ --- -sidebar_position: 1 slug: /1005/what-is-cue/ -sidebar_label: What is Cue? --- # What is Cue? @@ -123,27 +121,27 @@ import ( ) // more on packages later #Person: { - + // further constrain to a min and max length - Name: string & strings.MinRunes(3) & strings.MaxRunes(22) - - // we don't need string because the regex handles that + Name: string & strings.MinRunes(3) & strings.MaxRunes(22) + + // we don't need string because the regex handles that Email: =~"^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$" // further constrain to realistic ages - Age?: int & >0 & <140 + Age?: int & >0 & <140 } Bob: #Person & { - Name: "Bob Smith" + Name: "Bob Smith" Email: "bob@smith.com" Age: 42 } // output in YAML: -Bob: - Name: Bob Smith +Bob: + Name: Bob Smith Email: bob@smith.com Age: 42 @@ -161,15 +159,15 @@ import ( ) #Person: { - + // further constrain to a min and max length - Name: string & strings.MinRunes(3) & strings.MaxRunes(22) - - // we don't need string because the regex handles that + Name: string & strings.MinRunes(3) & strings.MaxRunes(22) + + // we don't need string because the regex handles that Email: =~"^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$" // further constrain to realistic ages - Age?: int & >0 & <140 + Age?: int & >0 & <140 // Job is optional and a string Job?: string @@ -181,7 +179,7 @@ import ( Bob: #Engineer & { - Name: "Bob Smith" + Name: "Bob Smith" Email: "bob@smith.com" Age: 42 // Job: "Carptenter" // would result in an error diff --git a/docs/learn/_category_.json b/docs/learn/_category_.json deleted file mode 100644 index 23ba8b53..00000000 --- a/docs/learn/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Learn Dagger", - "position": 2, - "collapsed": false -} diff --git a/docs/reference/_category_.json b/docs/reference/_category_.json deleted file mode 100644 index 5db33572..00000000 --- a/docs/reference/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Universe - API Reference", - "position": 5, - "collapsed": false -} diff --git a/docs/use-cases/_category_.json b/docs/use-cases/_category_.json deleted file mode 100644 index 0a1635c2..00000000 --- a/docs/use-cases/_category_.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "label": "Use Cases", - "position": 3, - "collapsed": false -} diff --git a/website/sidebars.js b/website/sidebars.js index c07b2c8d..6d961d5c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -10,19 +10,57 @@ */ module.exports = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [ - { type: 'autogenerated', dirName: '.' }, - ], - - // But you can create a sidebar manually - /* tutorialSidebar: [ { - type: 'category', - label: 'Tutorial', - items: ['hello'], + type: "category", + label: "Introduction", + collapsible: false, + items: ["introduction/what_is", "introduction/vs"], + }, + { + type: "doc", + id: "install", + }, + { + type: "category", + label: "Learn Dagger", + collapsible: false, + items: [ + "learn/what_is_cue", + "learn/get-started", + "learn/first-env", + "learn/google-cloud-run", + "learn/kubernetes", + "learn/aws-cloudformation", + "learn/github-actions", + "learn/dev-cue-package", + "learn/package-manager", + ], + }, + { + type: "category", + label: "Use Cases", + collapsible: false, + items: ["use-cases/ci"], + }, + { + type: "category", + label: "Universe - API Reference", + collapsible: true, + collapsed: false, + // generate the sidebar for reference doc automatically + items: [ + { + type: "autogenerated", + dirName: "reference", + }, + ], + }, + { + type: "category", + label: "Administrator Manual", + collapsible: false, + items: ["administrator/operator-manual"], }, ], - */ }; From acc602db69f2d530b214cf02ccf90b044f4c9f80 Mon Sep 17 00:00:00 2001 From: Andrea Luzzardi Date: Fri, 8 Oct 2021 16:45:50 -0700 Subject: [PATCH 2/2] docs: remove "Create your first Dagger Environment" from sidebar Signed-off-by: Andrea Luzzardi --- website/sidebars.js | 1 - 1 file changed, 1 deletion(-) diff --git a/website/sidebars.js b/website/sidebars.js index 6d961d5c..390cacae 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -28,7 +28,6 @@ module.exports = { items: [ "learn/what_is_cue", "learn/get-started", - "learn/first-env", "learn/google-cloud-run", "learn/kubernetes", "learn/aws-cloudformation",