From 9371bed87928601c5e3de5b5637dd99599efc5a9 Mon Sep 17 00:00:00 2001 From: Jonathan Matthews Date: Thu, 2 Nov 2023 12:05:41 +0000 Subject: [PATCH] docs: landing page This change modifies the /docs landing page by adding an explanation of each top-level section's content and purpose in card containers. It also uses the wide header form, in keeping with the rest of the documentation pages, and hides the automatically generated index of sub-pages. Preview-Path: /docs Signed-off-by: Jonathan Matthews Change-Id: I76559feb7dd4b46ffc73f753b8cf53ac21ed4fad Dispatch-Trailer: {"type":"trybot","CL":1171583,"patchset":3,"ref":"refs/changes/83/1171583/3","targetBranch":"alpha"} --- content/docs/_en.html | 356 ------------------------------- content/docs/_en.md | 71 ++++++ hugo/content/en/docs/_index.html | 356 ------------------------------- hugo/content/en/docs/_index.md | 71 ++++++ 4 files changed, 142 insertions(+), 712 deletions(-) delete mode 100644 content/docs/_en.html create mode 100644 content/docs/_en.md delete mode 100644 hugo/content/en/docs/_index.html create mode 100644 hugo/content/en/docs/_index.md diff --git a/content/docs/_en.html b/content/docs/_en.html deleted file mode 100644 index 3c951eeb66..0000000000 --- a/content/docs/_en.html +++ /dev/null @@ -1,356 +0,0 @@ ---- -title: "Documentation" -description: "More about what CUE is and how to use it." -layout: index -header_type: default -cascade: - header_type: wide ---- - -
-
-
-

Welcome to CUE

- -
-

- CUE is an open-source data validation language and inference engine - with its roots in logic programming. - Although the language is not a general-purpose programming language, - it has many applications, such as - data validation, data templating, configuration, querying, - code generation and even scripting. - The inference engine can be used to validate - data in code or to include it as part of a code generation pipeline. -

-
-
-
- -
-
-
-
-

Language Guide

-
-
-

Learn everything you need to about CUE. The Language Guide is a learning - journey broken down into the different aspects of CUE: data, templating, - schemas, queries, policy, file organization, and interoperability with - other languages/encodings.

- {{< button href="/docs/language-guide" label="Get started" icon="chevron-right" theme="white" >}} -
-
-
-
- -
-
- -

Introduction

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Tutorials

- - - -

How-To Guides

- - -
-
-
diff --git a/content/docs/_en.md b/content/docs/_en.md new file mode 100644 index 0000000000..aba87f215a --- /dev/null +++ b/content/docs/_en.md @@ -0,0 +1,71 @@ +--- +title: "Documentation" +index_hide: true +cascade: + header_type: wide +--- + +# Welcome to CUE! + +CUE is an open-source data validation language and inference engine +with its roots in logic programming. +Although the language is not a general-purpose programming language +it supports and simplifies a wide variety of applications, such as +[data validation]({{< relref "concept/data-validation-use-case" >}}), +[configuration]({{< relref "concept/configuration-use-case" >}}), +[querying]({{< relref "language-guide/templating/comprehensions" >}}), +and [code generation]({{< relref "concept/code-generation-and-extraction-use-case" >}}). + + + +The inference engine can be used to validate +data in code, or to include it as part of a code generation pipeline. + +## How to use this documentation + +Select a section from the navigation bar on the left hand side of the page, or +from this brief explanation of each section: + +{{< cards >}} + +{{< card href="introduction/" label="Introduction" title="A great place to start" >}} + The Introduction is a quick trip through what's possible with CUE, suitable for + newcomers to the language. +{{< /card >}} + +{{< card href="language-guide/" label="Language Guide" title="A deep dive into CUE" >}} + The Language Guide is a detailed learning journey broken down into the + different aspects of CUE: data, templating, schemas, queries, policy, file + organization, and interoperability with other languages/encodings. +{{< /card >}} + + +{{< card href="integrations/" label="Integrations" title="JSON, YAML, Go, Kubernetes, and more" >}} + Learn how CUE integrates with a wide ecosystem of formats and tools. +{{< /card >}} + +{{< card href="tutorial/" label="Tutorials" title="Learn about CUE techniques and tools" >}} + The Tutorials section demonstrates different language and tooling features + through self-contained lessons, broken down into steps you can safely perform + on your own computer. +{{< /card >}} + +{{< card href="howto/" label="How-to Guides" title="Directions to achieve specific goals" >}} + Each of the How-to Guides contains practical steps for completing a task with + CUE. +{{< /card >}} + +{{< card href="concept/" label="Concept Guides" title="Understand CUE in more depth" >}} + Concept Guides explore the approaches that CUE makes possible through a + deeper understanding of the ideas and theory that drive the language. +{{< /card >}} + +{{< card href="reference/" label="Reference" title="CUE's source of truth" >}} + References include the CUE language specification, a glossary of terms, the + project's code of conduct, and more. +{{< /card >}} + +{{< /cards >}} diff --git a/hugo/content/en/docs/_index.html b/hugo/content/en/docs/_index.html deleted file mode 100644 index 3c951eeb66..0000000000 --- a/hugo/content/en/docs/_index.html +++ /dev/null @@ -1,356 +0,0 @@ ---- -title: "Documentation" -description: "More about what CUE is and how to use it." -layout: index -header_type: default -cascade: - header_type: wide ---- - -
-
-
-

Welcome to CUE

- -
-

- CUE is an open-source data validation language and inference engine - with its roots in logic programming. - Although the language is not a general-purpose programming language, - it has many applications, such as - data validation, data templating, configuration, querying, - code generation and even scripting. - The inference engine can be used to validate - data in code or to include it as part of a code generation pipeline. -

-
-
-
- -
-
-
-
-

Language Guide

-
-
-

Learn everything you need to about CUE. The Language Guide is a learning - journey broken down into the different aspects of CUE: data, templating, - schemas, queries, policy, file organization, and interoperability with - other languages/encodings.

- {{< button href="/docs/language-guide" label="Get started" icon="chevron-right" theme="white" >}} -
-
-
-
- -
-
- -

Introduction

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Tutorials

- - - -

How-To Guides

- - -
-
-
diff --git a/hugo/content/en/docs/_index.md b/hugo/content/en/docs/_index.md new file mode 100644 index 0000000000..aba87f215a --- /dev/null +++ b/hugo/content/en/docs/_index.md @@ -0,0 +1,71 @@ +--- +title: "Documentation" +index_hide: true +cascade: + header_type: wide +--- + +# Welcome to CUE! + +CUE is an open-source data validation language and inference engine +with its roots in logic programming. +Although the language is not a general-purpose programming language +it supports and simplifies a wide variety of applications, such as +[data validation]({{< relref "concept/data-validation-use-case" >}}), +[configuration]({{< relref "concept/configuration-use-case" >}}), +[querying]({{< relref "language-guide/templating/comprehensions" >}}), +and [code generation]({{< relref "concept/code-generation-and-extraction-use-case" >}}). + + + +The inference engine can be used to validate +data in code, or to include it as part of a code generation pipeline. + +## How to use this documentation + +Select a section from the navigation bar on the left hand side of the page, or +from this brief explanation of each section: + +{{< cards >}} + +{{< card href="introduction/" label="Introduction" title="A great place to start" >}} + The Introduction is a quick trip through what's possible with CUE, suitable for + newcomers to the language. +{{< /card >}} + +{{< card href="language-guide/" label="Language Guide" title="A deep dive into CUE" >}} + The Language Guide is a detailed learning journey broken down into the + different aspects of CUE: data, templating, schemas, queries, policy, file + organization, and interoperability with other languages/encodings. +{{< /card >}} + + +{{< card href="integrations/" label="Integrations" title="JSON, YAML, Go, Kubernetes, and more" >}} + Learn how CUE integrates with a wide ecosystem of formats and tools. +{{< /card >}} + +{{< card href="tutorial/" label="Tutorials" title="Learn about CUE techniques and tools" >}} + The Tutorials section demonstrates different language and tooling features + through self-contained lessons, broken down into steps you can safely perform + on your own computer. +{{< /card >}} + +{{< card href="howto/" label="How-to Guides" title="Directions to achieve specific goals" >}} + Each of the How-to Guides contains practical steps for completing a task with + CUE. +{{< /card >}} + +{{< card href="concept/" label="Concept Guides" title="Understand CUE in more depth" >}} + Concept Guides explore the approaches that CUE makes possible through a + deeper understanding of the ideas and theory that drive the language. +{{< /card >}} + +{{< card href="reference/" label="Reference" title="CUE's source of truth" >}} + References include the CUE language specification, a glossary of terms, the + project's code of conduct, and more. +{{< /card >}} + +{{< /cards >}}