Skip to content

Commit 8986233

Browse files
committed
cmd/cue: add a reference to the Central Registry from cue help modules
The `cue help modules` text does not mention the central registry directly. Change the docs to include a link to something explaining how to work it. Fixes #3202 Signed-off-by: Roger Peppe <[email protected]> Change-Id: Iac942507a2497e10b386008e9abdd773bc259b4a Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1198081 TryBot-Result: CUEcueckoo <[email protected]> Unity-Result: CUE porcuepine <[email protected]> Reviewed-by: Daniel Martí <[email protected]>
1 parent e9bc377 commit 8986233

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

cmd/cue/cmd/help.go

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,18 @@ A module is a collection of packages that are released, versioned, and
279279
distributed together. Modules are downloaded from OCI-compliant
280280
artifact registries.
281281
282+
The Central Registry for CUE modules (` + modconfig.DefaultRegistry + `) is
283+
used as the source for external modules by default.
284+
282285
For a detailed reference on modules:
283286
284287
https://cuelang.org/docs/reference/modules/
285288
289+
For tutorials on how to use the Central Registry, see:
290+
291+
https://cuelang.org/docs/tutorial/working-with-the-central-registry/
292+
https://cuelang.org/docs/tutorial/publishing-modules-to-the-central-registry/
293+
286294
For a tutorial on how to work with a custom OCI registry for CUE modules:
287295
288296
https://cuelang.org/docs/tutorial/working-with-a-custom-module-registry/
@@ -303,8 +311,8 @@ Given a particular registry configuration, it's possible to work what registry a
303311
given module is stored in, and what repository within that registry, without
304312
making any network calls.
305313
306-
If no explicit registry configuration is present, a default central registry
307-
(` + modconfig.DefaultRegistry + `) will be used for all modules.
314+
If no explicit registry configuration is present, a default Central Registry
315+
(` + modconfig.DefaultRegistry + `) is used for all modules.
308316
309317
The simplest way of specifying a registry configuration is to set $CUE_REGISTRY
310318
to the hostname of that registry.

cmd/cue/cmd/testdata/script/help_registryconfig.txtar

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Given a particular registry configuration, it's possible to work what registry a
1111
given module is stored in, and what repository within that registry, without
1212
making any network calls.
1313

14-
If no explicit registry configuration is present, a default central registry
15-
(registry.cue.works) will be used for all modules.
14+
If no explicit registry configuration is present, a default Central Registry
15+
(registry.cue.works) is used for all modules.
1616

1717
The simplest way of specifying a registry configuration is to set $CUE_REGISTRY
1818
to the hostname of that registry.

0 commit comments

Comments
 (0)