Skip to content

Commit

Permalink
docs/reference: add modules landing page
Browse files Browse the repository at this point in the history
This re-restablishes the path /docs/reference/modules/ by using it to
present a landing page for CUE modules.

A brief introduction provides some context, before leading on to 6 pages
selected to give a rounded impression of the modules-related resources
available to the reader. The landing page is included in the set of
pages which will persist in the LH nav, no matter which Reference
sub-page is being viewed.

The "modules" tag is linked to, instead of providing a dynamic on-page
list of the tagged content, because the search shortcode can't
pre-populate a query with a tag. This is tracked in cue-lang/cue#3394.

Also: the modules reference manual is retitled slightly in order to
provide a clear user experience when linking to it by title from across
the site, and has its "toc_hide: true" removed, so that it persists in
the reference/modules/ section's LH nav even when the guide itself isn't
open.

Preview-Path: /docs/reference/modules/
Preview-Path: /docs/reference/modules/manual/
Preview-Path: /docs/reference/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: Ia8dc6b1d6e4909469a34200d97ff4f0a2ea6e076
Dispatch-Trailer: {"type":"trybot","CL":1199965,"patchset":3,"ref":"refs/changes/65/1199965/3","targetBranch":"master"}
  • Loading branch information
jpluscplusm authored and cueckoo committed Aug 27, 2024
1 parent ff92bfb commit 1e51254
Show file tree
Hide file tree
Showing 7 changed files with 125 additions and 14 deletions.
2 changes: 1 addition & 1 deletion content/docs/reference/_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/manual/" >}}\
{{< card title="Modules" label="reference/modules" href="modules/" >}}\
CUE's dependency management system
{{< /card >}}

Expand Down
57 changes: 57 additions & 0 deletions content/docs/reference/modules/_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: CUE Modules
tags: [modules]
weight: 60
index_hide: true
---

Modules are how CUE manages dependencies
They must be published to a registry for users to fetch and work with.

Learn about CUE modules using the suggested links below,
or follow the {{<tag modules>}} tag to explore the full range of modules-related
pages on the site.

{{<cards>}}
{{<card title="Reference manual"
label="reference/manual"
href="manual/"
>}}
The CUE modules reference manual and glossary
{{</card>}}

{{<card title="Concept Guide"
label="concept/faq"
href="/docs/concept/faq/new-modules-vs-old-modules/"
>}}
CUE's "new" versus "old" modules -- your questions: answered
{{</card>}}

{{<card title="The cue command"
label="reference/command/cue"
href="/docs/reference/command/cue-help-modules"
>}}
The built-in help text for\
`cue help modules`
{{</card>}}

{{<card title="Getting started"
label="tutorial"
href="/docs/tutorial/working-with-the-central-registry/"
>}}
Working with the CUE Central Registry
{{</card>}}
{{<card title="Collaborate"
label="tutorial"
href="/docs/tutorial/publishing-modules-to-the-central-registry/"
>}}
Publishing modules to the Central Registry
{{</card>}}

{{<card title="Private infrastructure"
label="tutorial"
href="/docs/tutorial/working-with-a-custom-module-registry/"
>}}
Working with a custom module registry
{{</card>}}
{{</cards>}}
9 changes: 3 additions & 6 deletions content/docs/reference/modules/manual/en.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: CUE Modules
authors:
- rogpeppe
toc_hide: true
tags:
- modules
title: Modules reference manual
authors: [rogpeppe]
tags: [modules]
---

## Introduction {#intro}
Expand Down
3 changes: 3 additions & 0 deletions content/docs/reference/modules/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: reference: modules: page: _
2 changes: 1 addition & 1 deletion hugo/content/en/docs/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/manual/" >}}\
{{< card title="Modules" label="reference/modules" href="modules/" >}}\
CUE's dependency management system
{{< /card >}}

Expand Down
57 changes: 57 additions & 0 deletions hugo/content/en/docs/reference/modules/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: CUE Modules
tags: [modules]
weight: 60
index_hide: true
---

Modules are how CUE manages dependencies
They must be published to a registry for users to fetch and work with.

Learn about CUE modules using the suggested links below,
or follow the {{<tag modules>}} tag to explore the full range of modules-related
pages on the site.

{{<cards>}}
{{<card title="Reference manual"
label="reference/manual"
href="manual/"
>}}
The CUE modules reference manual and glossary
{{</card>}}

{{<card title="Concept Guide"
label="concept/faq"
href="/docs/concept/faq/new-modules-vs-old-modules/"
>}}
CUE's "new" versus "old" modules -- your questions: answered
{{</card>}}

{{<card title="The cue command"
label="reference/command/cue"
href="/docs/reference/command/cue-help-modules"
>}}
The built-in help text for\
`cue help modules`
{{</card>}}

{{<card title="Getting started"
label="tutorial"
href="/docs/tutorial/working-with-the-central-registry/"
>}}
Working with the CUE Central Registry
{{</card>}}
{{<card title="Collaborate"
label="tutorial"
href="/docs/tutorial/publishing-modules-to-the-central-registry/"
>}}
Publishing modules to the Central Registry
{{</card>}}

{{<card title="Private infrastructure"
label="tutorial"
href="/docs/tutorial/working-with-a-custom-module-registry/"
>}}
Working with a custom module registry
{{</card>}}
{{</cards>}}
9 changes: 3 additions & 6 deletions hugo/content/en/docs/reference/modules/manual/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: CUE Modules
authors:
- rogpeppe
toc_hide: true
tags:
- modules
title: Modules reference manual
authors: [rogpeppe]
tags: [modules]
---

## Introduction {#intro}
Expand Down

0 comments on commit 1e51254

Please sign in to comment.