Merge pull request #1052 from aluzzardi/docs-manual-sidebar

docs: define sidebar manually
This commit is contained in:
Andrea Luzzardi 2021-10-08 18:02:41 -07:00 committed by GitHub
commit 36d49b4c18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 62 additions and 56 deletions

View File

@ -1,5 +1,4 @@
---
sidebar_position: 2
slug: /1001/install/
---

View File

@ -1,5 +0,0 @@
{
"label": "Administrator Manual",
"position": 6,
"collapsed": false
}

View File

@ -1,5 +1,4 @@
---
sidebar_position: 2
slug: /1002/vs/
---

View File

@ -1,5 +0,0 @@
{
"label": "Introduction",
"position": 1,
"collapsed": false
}

View File

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

View File

@ -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

View File

@ -1,5 +0,0 @@
{
"label": "Learn Dagger",
"position": 2,
"collapsed": false
}

View File

@ -1,5 +0,0 @@
{
"label": "Universe - API Reference",
"position": 5,
"collapsed": false
}

View File

@ -1,5 +0,0 @@
{
"label": "Use Cases",
"position": 3,
"collapsed": false
}

View File

@ -10,19 +10,56 @@
*/
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/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"],
},
],
*/
};