Skip to content

Commit

Permalink
docs/tour: move /docs/intro/tour to /docs/tour
Browse files Browse the repository at this point in the history
This change moves the contents of /docs/introduction/tour from under the
Introduction top-level container to a new (temporary) Tours container.

It names the tour "The Basics of CUE". Its current unnamed state
resulted from it being the /only/ tour that's imported from
https://cuelang.org/docs/tutorials/.

This change establishes the /docs/tour/ hierararchy as a temporary
measure, designed to receive the other 4 tours from
https://cuelang.org/docs/tutorials/, but with the intent to remove the
top-level container as&when the Language Guide is able to replace the
majority of the 5 tours. If there's any important content from those
tours that's /not/ suitable for inclusion in the Language Guide, we can
make a judgement call about moving that content to a more suitable
location, or keeping the Tours hierarchy around.

Hugo's auto-listing of sub-pages is put to reasonably good use, by
prefixing it with an H2 that makes the list look more like part of the
same page than before the change. This approach will be used throughout
the process of importing the additional 4 tours from cuelang.org.

For cue-lang/docs-and-content#25

Preview-Path: /docs/tour/
Preview-Path: /docs/tour/basics/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I7cc5e0de7f653404533ac85aa45fe812aaa630e6
Dispatch-Trailer: {"type":"trybot","CL":1171468,"patchset":1,"ref":"refs/changes/68/1171468/1","targetBranch":"alpha"}
  • Loading branch information
jpluscplusm authored and cueckoo committed Oct 31, 2023
1 parent 3591d71 commit 845681f
Show file tree
Hide file tree
Showing 40 changed files with 75 additions and 49 deletions.
11 changes: 0 additions & 11 deletions content/docs/introduction/tour/_en.md

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/constraints/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/definitions/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/duplicate-fields/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/folding-structs/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/json-superset/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/order-irrelevance/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/types-are-values/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/introduction/tour/validation/page.cue

This file was deleted.

16 changes: 16 additions & 0 deletions content/docs/tour/_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Tours
weight: 15
---

{{< info >}}
These tours of CUE are being actively developed, and their contents may migrate
into other sections of the CUE documentation site over time. In particular the
[Language Guide]({{< relref "language-guide.md" >}}) will provide a deep dive
into CUE, covering many of the topics currently included in these tours.
{{< /info >}}

If you're new to CUE, get a quick start with a tour of
[the basics of CUE]({{< relref "basics" >}}), or select a different tour.

## Available Tours
8 changes: 8 additions & 0 deletions content/docs/tour/basics/_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "The Basics of CUE"
---

This tour demonstrates the simplest ideas and syntax you'll use when reading
and writing CUE.

## Contents
File renamed without changes.
3 changes: 3 additions & 0 deletions content/docs/tour/basics/constraints/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "constraints": {}
File renamed without changes.
3 changes: 3 additions & 0 deletions content/docs/tour/basics/definitions/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "definitions": {}
3 changes: 3 additions & 0 deletions content/docs/tour/basics/duplicate-fields/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "duplicate-fields": {}
3 changes: 3 additions & 0 deletions content/docs/tour/basics/folding-structs/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "folding-structs": {}
3 changes: 3 additions & 0 deletions content/docs/tour/basics/json-superset/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "json-superset": {}
3 changes: 3 additions & 0 deletions content/docs/tour/basics/order-irrelevance/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "order-irrelevance": {}
3 changes: 3 additions & 0 deletions content/docs/tour/basics/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: {}
3 changes: 3 additions & 0 deletions content/docs/tour/basics/types-are-values/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "types-are-values": {}
File renamed without changes.
3 changes: 3 additions & 0 deletions content/docs/tour/basics/validation/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: tour: basics: "validation": {}
11 changes: 0 additions & 11 deletions hugo/content/en/docs/introduction/tour/_index.md

This file was deleted.

16 changes: 16 additions & 0 deletions hugo/content/en/docs/tour/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Tours
weight: 15
---

{{< info >}}
These tours of CUE are being actively developed, and their contents may migrate
into other sections of the CUE documentation site over time. In particular the
[Language Guide]({{< relref "language-guide.md" >}}) will provide a deep dive
into CUE, covering many of the topics currently included in these tours.
{{< /info >}}

If you're new to CUE, get a quick start with a tour of
[the basics of CUE]({{< relref "basics" >}}), or select a different tour.

## Available Tours
8 changes: 8 additions & 0 deletions hugo/content/en/docs/tour/basics/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "The Basics of CUE"
---

This tour demonstrates the simplest ideas and syntax you'll use when reading
and writing CUE.

## Contents

0 comments on commit 845681f

Please sign in to comment.