docs/reference: move modules/ to modules/manual/

This moves the modules reference manual from /docs/reference/modules/ to /docs/reference/modules/manual/. This is done to free up the former path, allowing it to function as the landing page for modules in later changes. Pages across the site which link to the manual are updated. The previous path is left entirely empty in this commit (i.e. it would serve a 404) specifically so that git/gerrit review shows that the file containing the Markdown source for the guide was renamed/moved intact. The path has content re-added by later changes, and this change will not be submitted alone, so this hypothetical 404 will never be served. A Hugo alias is not added to the temporarily-empty path for the same reason. Preview-Path: /docs/reference/modules/manual/ Signed-off-by: Jonathan Matthews <[email protected]> Change-Id: I90930a4e018640e62b9589610cf49ed0582e7866 Dispatch-Trailer: {"type":"trybot","CL":1199964,"patchset":1,"ref":"refs/changes/64/1199964/1","targetBranch":"master"}
cue-lang · Aug 23, 2024 · 2b1b3fa · 2b1b3fa
1 parent 1533726
commit 2b1b3fa
Show file tree

Hide file tree

Showing 22 changed files with 46 additions and 44 deletions.
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
@@ -59,7 +59,7 @@ so we encourage you to explore and adopt them before then!
 {{< linkto/inline "tutorial/working-with-a-custom-module-registry" >}}
 present an easy-to-digest introduction to modules.
 The {{<tag modules>}} tag lists other modules-related content.
-The {{< linkto/inline "reference/modules" >}} reference is the definitive
+The {{< linkto/inline "reference/modules/manual" >}} reference is the definitive
 document that details how modules work.
 
 ## What is the Central Registry?
@@ -105,7 +105,7 @@ that it was written against an older version of the CUE language spec and
 semantics.
 
 See
-[the Modules reference document]({{< relref "docs/reference/modules" >}}#cue-mod-file)
+[the Modules reference document]({{< relref "docs/reference/modules/manual" >}}#cue-mod-file)
 for an explanation of the various fields in a `cue.mod/module.cue` file.
 
 ## What about old modules that don't have a `language.version` field?

diff --git a/content/docs/reference/_en.md b/content/docs/reference/_en.md
@@ -16,7 +16,7 @@ Help texts for the `cue` command and its subcommands
 {{< /card >}}
 
 <!-- The trailing "\" on the next line vertically aligns the card's body with the spec card's body -->
-{{< card title="Modules" label="reference/modules" href="modules/" >}}\
+{{< card title="Modules" label="reference/modules" href="modules/manual/" >}}\
 CUE's dependency management system
 {{< /card >}}
 

diff --git a/content/docs/reference/modules/gen_cache.cue b/content/docs/reference/modules/gen_cache.cue
diff --git a/content/docs/reference/modules/buildlist.svg → ...cs/reference/modules/manual/buildlist.svg b/content/docs/reference/modules/buildlist.svg → ...cs/reference/modules/manual/buildlist.svg
diff --git a/content/docs/reference/modules/en.md → content/docs/reference/modules/manual/en.md b/content/docs/reference/modules/en.md → content/docs/reference/modules/manual/en.md
diff --git a/content/docs/reference/modules/manual/gen_cache.cue b/content/docs/reference/modules/manual/gen_cache.cue
@@ -0,0 +1,21 @@
+package site
+{
+	content: {
+		docs: {
+			reference: {
+				modules: {
+					manual: {
+						page: {
+							cache: {
+								code: {
+									"module.cue schema":  "7cWN6k7fEnRSRe3w6rT/Htrv4tjP5SB63FgJ0gC+DCE="
+									"module.cue example": "ZYcFwVPB6IQGp04Op4TJt+MwoQSJXKXs14NYfsejVdQ="
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}
diff --git a/content/docs/reference/modules/manual/page.cue b/content/docs/reference/modules/manual/page.cue
@@ -0,0 +1,3 @@
+package site
+
+content: docs: reference: modules: manual: page: _
diff --git a/content/docs/reference/modules/page.cue b/content/docs/reference/modules/page.cue
diff --git a/content/docs/tutorial/publishing-modules-to-the-central-registry/en.md b/content/docs/tutorial/publishing-modules-to-the-central-registry/en.md
@@ -304,4 +304,4 @@ configuration held in a different module.
 
 - {{< linkto/related/tutorial "working-with-the-central-registry" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
diff --git a/content/docs/tutorial/using-modules-with-go-api/en.md b/content/docs/tutorial/using-modules-with-go-api/en.md
@@ -224,5 +224,5 @@ Well done - you've finished this tutorial! In completing it, you:
 
 ## Related content
 
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
diff --git a/content/docs/tutorial/working-with-a-custom-module-registry/en.md b/content/docs/tutorial/working-with-a-custom-module-registry/en.md
@@ -584,4 +584,4 @@ dependency resolution.
 
 - {{< linkto/related/tutorial "working-with-the-central-registry" >}}
 - {{< linkto/related/tutorial "publishing-modules-to-the-central-registry" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
diff --git a/content/docs/tutorial/working-with-the-central-registry/en.md b/content/docs/tutorial/working-with-the-central-registry/en.md
@@ -139,4 +139,4 @@ module from the Central Registry!
 
 - {{< linkto/related/tutorial "publishing-modules-to-the-central-registry" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
diff --git a/content/examples/shortcodes/linkto/en.md b/content/examples/shortcodes/linkto/en.md
@@ -34,14 +34,14 @@ linking to the language spec.
 ```
 - {{</* linkto/related/concept "the-logic-of-cue" */>}}
 - {{</* linkto/related/howto "use-strings-replace" */>}}
-- {{</* linkto/related/reference "modules" */>}}
+- {{</* linkto/related/reference "modules/manual" */>}}
 - {{</* linkto/related/tutorial "working-with-a-custom-module-registry" */>}}
 - {{</* linkto/related/tour "expressions/fieldcomp" */>}}
 ```
 
 - {{< linkto/related/concept "the-logic-of-cue" >}}
 - {{< linkto/related/howto "use-strings-replace" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
 - {{< linkto/related/tour "expressions/fieldcomp" >}}
 
@@ -69,14 +69,14 @@ URL fragments cannot be included.
 There are several relevant pages: 
 {{</* linkto/inline "concept/the-logic-of-cue" */>}},
 {{</* linkto/inline "howto/use-strings-replace" */>}},
-{{</* linkto/inline "reference/modules" */>}},
+{{</* linkto/inline "reference/modules/manual" */>}},
 {{</* linkto/inline "tutorial/working-with-a-custom-module-registry" */>}}, and
 {{</* linkto/inline "tour/expressions/fieldcomp" */>}}.
 ```
 
 There are several relevant pages: 
 {{< linkto/inline "concept/the-logic-of-cue" >}},
 {{< linkto/inline "howto/use-strings-replace" >}},
-{{< linkto/inline "reference/modules" >}},
+{{< linkto/inline "reference/modules/manual" >}},
 {{< linkto/inline "tutorial/working-with-a-custom-module-registry" >}}, and
 {{< linkto/inline "tour/expressions/fieldcomp" >}}.
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
@@ -59,7 +59,7 @@ so we encourage you to explore and adopt them before then!
 {{< linkto/inline "tutorial/working-with-a-custom-module-registry" >}}
 present an easy-to-digest introduction to modules.
 The {{<tag modules>}} tag lists other modules-related content.
-The {{< linkto/inline "reference/modules" >}} reference is the definitive
+The {{< linkto/inline "reference/modules/manual" >}} reference is the definitive
 document that details how modules work.
 
 ## What is the Central Registry?
@@ -105,7 +105,7 @@ that it was written against an older version of the CUE language spec and
 semantics.
 
 See
-[the Modules reference document]({{< relref "docs/reference/modules" >}}#cue-mod-file)
+[the Modules reference document]({{< relref "docs/reference/modules/manual" >}}#cue-mod-file)
 for an explanation of the various fields in a `cue.mod/module.cue` file.
 
 ## What about old modules that don't have a `language.version` field?

diff --git a/hugo/content/en/docs/reference/_index.md b/hugo/content/en/docs/reference/_index.md
@@ -16,7 +16,7 @@ Help texts for the `cue` command and its subcommands
 {{< /card >}}
 
 <!-- The trailing "\" on the next line vertically aligns the card's body with the spec card's body -->
-{{< card title="Modules" label="reference/modules" href="modules/" >}}\
+{{< card title="Modules" label="reference/modules" href="modules/manual/" >}}\
 CUE's dependency management system
 {{< /card >}}
 

diff --git a/...t/en/docs/reference/modules/buildlist.svg → ...cs/reference/modules/manual/buildlist.svg b/...t/en/docs/reference/modules/buildlist.svg → ...cs/reference/modules/manual/buildlist.svg
diff --git a/...ontent/en/docs/reference/modules/index.md → ...en/docs/reference/modules/manual/index.md b/...ontent/en/docs/reference/modules/index.md → ...en/docs/reference/modules/manual/index.md
diff --git a/hugo/content/en/docs/tutorial/publishing-modules-to-the-central-registry/index.md b/hugo/content/en/docs/tutorial/publishing-modules-to-the-central-registry/index.md
@@ -311,4 +311,4 @@ configuration held in a different module.
 
 - {{< linkto/related/tutorial "working-with-the-central-registry" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
diff --git a/hugo/content/en/docs/tutorial/using-modules-with-go-api/index.md b/hugo/content/en/docs/tutorial/using-modules-with-go-api/index.md
@@ -228,5 +228,5 @@ Well done - you've finished this tutorial! In completing it, you:
 
 ## Related content
 
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
diff --git a/hugo/content/en/docs/tutorial/working-with-a-custom-module-registry/index.md b/hugo/content/en/docs/tutorial/working-with-a-custom-module-registry/index.md
@@ -615,4 +615,4 @@ dependency resolution.
 
 - {{< linkto/related/tutorial "working-with-the-central-registry" >}}
 - {{< linkto/related/tutorial "publishing-modules-to-the-central-registry" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
diff --git a/hugo/content/en/docs/tutorial/working-with-the-central-registry/index.md b/hugo/content/en/docs/tutorial/working-with-the-central-registry/index.md
@@ -146,4 +146,4 @@ module from the Central Registry!
 
 - {{< linkto/related/tutorial "publishing-modules-to-the-central-registry" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
diff --git a/hugo/content/en/examples/shortcodes/linkto/index.md b/hugo/content/en/examples/shortcodes/linkto/index.md
@@ -34,14 +34,14 @@ linking to the language spec.
 ```
 - {{</* linkto/related/concept "the-logic-of-cue" */>}}
 - {{</* linkto/related/howto "use-strings-replace" */>}}
-- {{</* linkto/related/reference "modules" */>}}
+- {{</* linkto/related/reference "modules/manual" */>}}
 - {{</* linkto/related/tutorial "working-with-a-custom-module-registry" */>}}
 - {{</* linkto/related/tour "expressions/fieldcomp" */>}}
 ```
 
 - {{< linkto/related/concept "the-logic-of-cue" >}}
 - {{< linkto/related/howto "use-strings-replace" >}}
-- {{< linkto/related/reference "modules" >}}
+- {{< linkto/related/reference "modules/manual" >}}
 - {{< linkto/related/tutorial "working-with-a-custom-module-registry" >}}
 - {{< linkto/related/tour "expressions/fieldcomp" >}}
 
@@ -69,14 +69,14 @@ URL fragments cannot be included.
 There are several relevant pages: 
 {{</* linkto/inline "concept/the-logic-of-cue" */>}},
 {{</* linkto/inline "howto/use-strings-replace" */>}},
-{{</* linkto/inline "reference/modules" */>}},
+{{</* linkto/inline "reference/modules/manual" */>}},
 {{</* linkto/inline "tutorial/working-with-a-custom-module-registry" */>}}, and
 {{</* linkto/inline "tour/expressions/fieldcomp" */>}}.
 ```
 
 There are several relevant pages: 
 {{< linkto/inline "concept/the-logic-of-cue" >}},
 {{< linkto/inline "howto/use-strings-replace" >}},
-{{< linkto/inline "reference/modules" >}},
+{{< linkto/inline "reference/modules/manual" >}},
 {{< linkto/inline "tutorial/working-with-a-custom-module-registry" >}}, and
 {{< linkto/inline "tour/expressions/fieldcomp" >}}.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		package site

		content: docs: reference: modules: manual: page: _