Outdated concept guide focuses on "old" modules #179
Assignees
Labels
bug
Something isn't working
Comments
cueckoo
pushed a commit
to cue-lang/cuelang.org-trybot
that referenced
this issue
Sep 6, 2024
This establishes the path /docs/concept/modules/ and uses it to present a landing page for CUE modules. A brief introduction provides some context, before leading on to 6 pages presented as a set of cards, selected to give a rounded impression of the modules-related resources available to the reader. 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. (Tracked in cue-lang/cue#3394). Also: this landing page takes the place of the "Modules, Packages, and Instances" concept guide on /docs/concept/popular-guides, whose outdated content being updated is tracked in cue-lang/docs-and-content#179. The modules tag is added to the outdated guide, so that it's at least discoverable whilst it's removed from the popular-guides page. Preview-Path: /docs/concept/modules/ Signed-off-by: Jonathan Matthews <[email protected]> Change-Id: Ia8dc6b1d6e4909469a34200d97ff4f0a2ea6e076 Signed-off-by: Jonathan Matthews <[email protected]> Dispatch-Trailer: {"type":"trybot","CL":1199965,"patchset":9,"ref":"refs/changes/65/1199965/9","targetBranch":"master"}
cueckoo
pushed a commit
to cue-lang/cuelang.org
that referenced
this issue
Sep 9, 2024
This establishes the path /docs/concept/modules/ and uses it to present a landing page for CUE modules. A brief introduction provides some context, before leading on to 6 pages presented as a set of cards, selected to give a rounded impression of the modules-related resources available to the reader. 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. (Tracked in cue-lang/cue#3394). Also: this landing page takes the place of the "Modules, Packages, and Instances" concept guide on /docs/concept/popular-guides, whose outdated content being updated is tracked in cue-lang/docs-and-content#179. The modules tag is added to the outdated guide, so that it's at least discoverable whilst it's removed from the popular-guides page. Preview-Path: /docs/concept/modules/ Signed-off-by: Jonathan Matthews <[email protected]> Change-Id: Ia8dc6b1d6e4909469a34200d97ff4f0a2ea6e076 Signed-off-by: Jonathan Matthews <[email protected]> Reviewed-on: https://review.gerrithub.io/c/cue-lang/cuelang.org/+/1199965 Reviewed-by: Paul Jolly <[email protected]> TryBot-Result: CUEcueckoo <[email protected]>
cueckoo
pushed a commit
to cue-lang/cuelang.org-trybot
that referenced
this issue
Sep 27, 2024
This updates the "Modules, Packages and Instances" concept guide for the
"new" modules implementation that's the default in CUE v0.9.0 and later.
This update is (mostly) intended to maintain the same document structure
and flow, whilst making sure that no incorrect prose is presented and
that deprecated features (such as cue.mod/{pkg,usr,gen}) aren't held out
as current and recommended.
The previous version of the guide is archived at a different path,
clearly marked as relating to "old" modules, and with an explanatory
preamble that should prevent anyone making an active choice to use old
modules if they don't need to for legacy reasons.
This update doesn't perform a full rewrite of the guide. That will be
done later, when the guide is moved under the /docs/concept/modules/
hierarchy. Some light, incidental rewording *is* included in this update
(beyond that required to meet this change's headline goal), but this
isn't exhaustive or complete. The guide's code blocks aren't modernised,
as this will also be done during the more significant rewrite.
Closes cue-lang/docs-and-content#179
Preview-Path: /docs/concept/modules-packages-instances/
Preview-Path: /docs/concept/old-modules-packages-instances/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I01ef4b5e21a60f966919a593797b90b1a420cf86
Dispatch-Trailer: {"type":"trybot","CL":1200085,"patchset":13,"ref":"refs/changes/85/1200085/13","targetBranch":"master"}
cueckoo
pushed a commit
to cue-lang/cuelang.org-trybot
that referenced
this issue
Oct 2, 2024
This updates the "Modules, Packages and Instances" concept guide for the
"new" modules implementation that's the default in CUE v0.9.0 and later.
This update is (mostly) intended to maintain the same document structure
and flow, whilst making sure that no incorrect prose is presented and
that deprecated features (such as cue.mod/{pkg,usr,gen}) aren't held out
as current and recommended.
The previous version of the guide is archived at a different path,
clearly marked as relating to "old" modules, and with an explanatory
preamble that should prevent anyone making an active choice to use old
modules if they don't need to for legacy reasons.
This update doesn't perform a full rewrite of the guide. That will be
done later, when the guide is moved under the /docs/concept/modules/
hierarchy. Some light, incidental rewording *is* included in this update
(beyond that required to meet this change's headline goal), but this
isn't exhaustive or complete. The guide's code blocks aren't modernised,
as this will also be done during the more significant rewrite.
Closes cue-lang/docs-and-content#179
Preview-Path: /docs/concept/modules-packages-instances/
Preview-Path: /docs/concept/old-modules-packages-instances/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I01ef4b5e21a60f966919a593797b90b1a420cf86
Dispatch-Trailer: {"type":"trybot","CL":1200085,"patchset":14,"ref":"refs/changes/85/1200085/14","targetBranch":"master"}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What page were you looking at?
https://cuelang.org/docs/concept/modules-packages-instances/
What version of the site were you looking at?
cue-lang/cuelang.org@bf5e1a7
What did you do?
I tried to understand CUE modules, as used in version 0.10 onwards.
What did you expect?
That this page would describe current CUE modules.
What did you see instead?
The page describes "old" CUE modules.
The text was updated successfully, but these errors were encountered: