From ab7e9e292a4b902628dbd4f1b457b143f20e10b8 Mon Sep 17 00:00:00 2001 From: Jonathan Matthews Date: Tue, 19 Nov 2024 12:28:26 +0000 Subject: [PATCH] docs/concept: page-level additions to section TOC This changes some pages' visibility inside the concept guide section's TOC. This is done to work better with a parallel CL's addition of a specific FAQ (symlinks) which makes sense to expose via the left-hand nav TOC. /docs/concept/faq/: - include in parent section's left-hand nav TOC, placed at the bottom. - include some on-page text introducing the list of FAQs, as the FAQ index will now be reachable from the left-hand nav. - remove "(With Answers)" from section title, as it muddies this section and the parent section's left-hand nav TOCs. /docs/concept/faq/*/: - include in FAQ's section's left-hand nav TOC. /docs/concept/modules/: - add a weight to fix the page's position near the top of the parent section's left-hand nav TOC. Preview-Path: /docs/concept/ Preview-Path: /docs/concept/faq/ Change-Id: I67d11ce37d3065ed3b024ed6342ff1f455887155 Signed-off-by: Jonathan Matthews Dispatch-Trailer: {"type":"trybot","CL":1204253,"patchset":8,"ref":"refs/changes/53/1204253/8","targetBranch":"master"} --- content/docs/concept/faq/_en.md | 8 ++++++-- content/docs/concept/faq/new-modules-vs-old-modules/en.md | 2 +- .../faq/removing-list-arithmetic-operators-v0.11/en.md | 2 +- content/docs/concept/modules/_en.md | 1 + content/docs/concept/the-logic-of-cue/en.md | 1 + hugo/content/en/docs/concept/faq/_index.md | 8 ++++++-- .../docs/concept/faq/new-modules-vs-old-modules/index.md | 2 +- .../faq/removing-list-arithmetic-operators-v0.11/index.md | 2 +- hugo/content/en/docs/concept/modules/_index.md | 1 + hugo/content/en/docs/concept/the-logic-of-cue/index.md | 1 + 10 files changed, 20 insertions(+), 8 deletions(-) diff --git a/content/docs/concept/faq/_en.md b/content/docs/concept/faq/_en.md index f746fef36b..029e0e8601 100644 --- a/content/docs/concept/faq/_en.md +++ b/content/docs/concept/faq/_en.md @@ -1,6 +1,10 @@ --- -title: Frequently Asked Questions (With Answers) -toc_hide: true +title: Frequently Asked Questions +toc_hide: false +weight: 999 --- +CUE's FAQs collect common questions about specific topics together on a single +page, along with their answers. + The following FAQs are available: diff --git a/content/docs/concept/faq/new-modules-vs-old-modules/en.md b/content/docs/concept/faq/new-modules-vs-old-modules/en.md index c80f623391..ba7d0699d7 100644 --- a/content/docs/concept/faq/new-modules-vs-old-modules/en.md +++ b/content/docs/concept/faq/new-modules-vs-old-modules/en.md @@ -1,7 +1,7 @@ --- title: New modules vs old modules -toc_hide: true tags: [modules] +toc_hide: false --- The [v0.9.0](/releases/v0.9.0) release of CUE diff --git a/content/docs/concept/faq/removing-list-arithmetic-operators-v0.11/en.md b/content/docs/concept/faq/removing-list-arithmetic-operators-v0.11/en.md index f7af9133e3..9d0c203874 100644 --- a/content/docs/concept/faq/removing-list-arithmetic-operators-v0.11/en.md +++ b/content/docs/concept/faq/removing-list-arithmetic-operators-v0.11/en.md @@ -2,7 +2,7 @@ title: Removing list arithmetic operators in CUE 0.11 authors: [jpluscplusm] tags: [language] -toc_hide: true +toc_hide: false --- {{{with _script_ "en" "HIDDEN: set up access to CUE v0.11 before release"}}} diff --git a/content/docs/concept/modules/_en.md b/content/docs/concept/modules/_en.md index d89fcc8cd9..1e97caba15 100644 --- a/content/docs/concept/modules/_en.md +++ b/content/docs/concept/modules/_en.md @@ -2,6 +2,7 @@ title: Modules tags: [modules] toc_hide: false +weight: 30 --- Modules are how CUE manages native dependencies. diff --git a/content/docs/concept/the-logic-of-cue/en.md b/content/docs/concept/the-logic-of-cue/en.md index 10880b78e4..b6b03989f4 100644 --- a/content/docs/concept/the-logic-of-cue/en.md +++ b/content/docs/concept/the-logic-of-cue/en.md @@ -2,6 +2,7 @@ title: "The Logic of CUE" description: "Learn about CUE's theoretical basis and what makes it different." weight: 20 +toc_hide: false math: true aliases: - /docs/concepts/logic diff --git a/hugo/content/en/docs/concept/faq/_index.md b/hugo/content/en/docs/concept/faq/_index.md index f746fef36b..029e0e8601 100644 --- a/hugo/content/en/docs/concept/faq/_index.md +++ b/hugo/content/en/docs/concept/faq/_index.md @@ -1,6 +1,10 @@ --- -title: Frequently Asked Questions (With Answers) -toc_hide: true +title: Frequently Asked Questions +toc_hide: false +weight: 999 --- +CUE's FAQs collect common questions about specific topics together on a single +page, along with their answers. + The following FAQs are available: diff --git a/hugo/content/en/docs/concept/faq/new-modules-vs-old-modules/index.md b/hugo/content/en/docs/concept/faq/new-modules-vs-old-modules/index.md index b8044d3c4b..4326e37d4a 100644 --- a/hugo/content/en/docs/concept/faq/new-modules-vs-old-modules/index.md +++ b/hugo/content/en/docs/concept/faq/new-modules-vs-old-modules/index.md @@ -1,7 +1,7 @@ --- title: New modules vs old modules -toc_hide: true tags: [modules] +toc_hide: false --- The [v0.9.0](/releases/v0.9.0) release of CUE diff --git a/hugo/content/en/docs/concept/faq/removing-list-arithmetic-operators-v0.11/index.md b/hugo/content/en/docs/concept/faq/removing-list-arithmetic-operators-v0.11/index.md index 70954c0a47..e7a360b338 100644 --- a/hugo/content/en/docs/concept/faq/removing-list-arithmetic-operators-v0.11/index.md +++ b/hugo/content/en/docs/concept/faq/removing-list-arithmetic-operators-v0.11/index.md @@ -2,7 +2,7 @@ title: Removing list arithmetic operators in CUE 0.11 authors: [jpluscplusm] tags: [language] -toc_hide: true +toc_hide: false --- This guide answers some questions about a language change that happened in CUE diff --git a/hugo/content/en/docs/concept/modules/_index.md b/hugo/content/en/docs/concept/modules/_index.md index d89fcc8cd9..1e97caba15 100644 --- a/hugo/content/en/docs/concept/modules/_index.md +++ b/hugo/content/en/docs/concept/modules/_index.md @@ -2,6 +2,7 @@ title: Modules tags: [modules] toc_hide: false +weight: 30 --- Modules are how CUE manages native dependencies. diff --git a/hugo/content/en/docs/concept/the-logic-of-cue/index.md b/hugo/content/en/docs/concept/the-logic-of-cue/index.md index fdbe67b375..02f0d44aa5 100644 --- a/hugo/content/en/docs/concept/the-logic-of-cue/index.md +++ b/hugo/content/en/docs/concept/the-logic-of-cue/index.md @@ -2,6 +2,7 @@ title: "The Logic of CUE" description: "Learn about CUE's theoretical basis and what makes it different." weight: 20 +toc_hide: false math: true aliases: - /docs/concepts/logic