Skip to content
Permalink
Browse files

Initial outline

  • Loading branch information...
mpvl committed Aug 13, 2019
1 parent dde3c34 commit 7f99772f237f9d66e6ef5be02d721c0f44bb23f1
Showing with 8,387 additions and 527 deletions.
  1. +25 −1 assets/icons/logo.svg
  2. +44 −0 assets/scss/_variables_project.scss
  3. +15 −7 config.toml
  4. +75 −48 content/en/_index.html
  5. +6 −0 content/en/community/_index.md
  6. +5 −0 content/en/docs/_index.md
  7. +321 −0 content/en/docs/about/_index.md
  8. +6 −0 content/en/docs/concepts/_index.md
  9. +58 −0 content/en/docs/concepts/language/_index.md
  10. +39 −0 content/en/docs/concepts/language/basic.md
  11. +36 −0 content/en/docs/concepts/language/composite.md
  12. +21 −0 content/en/docs/concepts/language/evaluation.md
  13. +5 −0 content/en/docs/concepts/language/expressions.md
  14. 0 content/en/docs/concepts/language/functions.md
  15. +94 −0 content/en/docs/concepts/language/lattice.md
  16. +11 −0 content/en/docs/concepts/packages/_index.md
  17. +11 −0 content/en/docs/concepts/patterns/_index.md
  18. +6 −0 content/en/docs/concepts/scripting/_index.md
  19. +6 −0 content/en/docs/examples/_index.md
  20. +14 −0 content/en/docs/examples/cue-in-cue.md
  21. +7 −0 content/en/docs/examples/go.md
  22. +64 −0 content/en/docs/install/_index.md
  23. +5 −0 content/en/docs/integrations/_index.md
  24. +7 −0 content/en/docs/integrations/generic.md
  25. +230 −0 content/en/docs/integrations/go.md
  26. +7 −0 content/en/docs/integrations/javascript.md
  27. +140 −0 content/en/docs/integrations/json.md
  28. +46 −0 content/en/docs/integrations/k8s.md
  29. +45 −0 content/en/docs/integrations/openapi.md
  30. +159 −0 content/en/docs/integrations/protobuf.md
  31. +190 −0 content/en/docs/integrations/yaml.md
  32. +52 −0 content/en/docs/references/_index.md
  33. +15 −0 content/en/docs/tutorials/_index.md
  34. +18 −0 content/en/docs/usecases/_index.md
  35. +268 −0 content/en/docs/usecases/configuration.md
  36. +210 −0 content/en/docs/usecases/datadef.md
  37. +113 −0 content/en/docs/usecases/generate.md
  38. +31 −0 content/en/docs/usecases/query.md
  39. +20 −0 content/en/docs/usecases/scripting.md
  40. +140 −0 content/en/docs/usecases/validation.md
  41. +11 −0 layouts/index.redir
  42. +27 −0 layouts/partials/head.html
  43. +1 −0 layouts/partials/hooks/body-end.html
  44. +10 −0 layouts/shortcodes/blocks/cover.html
  45. +6 −0 layouts/shortcodes/imglink.html
  46. +490 −471 package-lock.json
  47. +2,564 −0 static/css/asciinema-player.css
  48. +898 −0 static/cue.cast
  49. +11 −0 static/golang/go.html
  50. BIN static/images/Go-Logo_Aqua.png
  51. +60 −0 static/images/Go-Logo_Aqua.svg
  52. +60 −0 static/images/Go-Logo_Blue.svg
  53. +1 −0 static/images/cue-white.svg
  54. +41 −0 static/images/cue.svg
  55. BIN static/images/go.png
  56. BIN static/images/istio-logo-92FF583709-seeklogo.com.png
  57. BIN static/images/istio.png
  58. +104 −0 static/images/json.svg
  59. +1 −0 static/images/k8s-horizontal.svg
  60. +1 −0 static/images/k8s-stacked.svg
  61. +1 −0 static/images/k8s.svg
  62. +161 −0 static/images/openapi-stacked.svg
  63. +162 −0 static/images/openapi-wide.svg
  64. BIN static/images/prometheus.png
  65. BIN static/images/protobuf_nano.png
  66. BIN static/images/yaml.png
  67. +1,212 −0 static/js/asciinema-player.js
@@ -1 +1,25 @@
<svg version="1.1" viewBox="0.0 0.0 338.3254593175853 338.3254593175853" fill="none" stroke="none" stroke-linecap="square" stroke-miterlimit="10" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg"><clipPath id="p.0"><path d="m0 0l338.32547 0l0 338.32547l-338.32547 0l0 -338.32547z" clip-rule="nonzero"/></clipPath><g clip-path="url(#p.0)"><path fill="#000000" fill-opacity="0.0" d="m0 0l338.32547 0l0 338.32547l-338.32547 0z" fill-rule="evenodd"/><path fill="#000000" fill-opacity="0.0" d="m13.191601 168.69029l0 0c0 -85.878105 69.617966 -155.49606 155.49606 -155.49606l0 0c41.240112 0 80.79115 16.382574 109.95232 45.543743c29.161163 29.161171 45.54373 68.712204 45.54373 109.952324l0 0c0 85.8781 -69.61795 155.49605 -155.49605 155.49605l0 0c-85.878105 0 -155.49606 -69.61795 -155.49606 -155.49605z" fill-rule="evenodd"/><path stroke="#4a86e8" stroke-width="24.0" stroke-linejoin="round" stroke-linecap="butt" d="m13.191601 168.69029l0 0c0 -85.878105 69.617966 -155.49606 155.49606 -155.49606l0 0c41.240112 0 80.79115 16.382574 109.95232 45.543743c29.161163 29.161171 45.54373 68.712204 45.54373 109.952324l0 0c0 85.8781 -69.61795 155.49605 -155.49605 155.49605l0 0c-85.878105 0 -155.49606 -69.61795 -155.49606 -155.49605z" fill-rule="evenodd"/><path fill="#000000" fill-opacity="0.0" d="m19.790026 168.69029l0 0c0 -82.2339 66.66374 -148.89764 148.89764 -148.89764l0 0c39.490112 0 77.36281 15.687384 105.286514 43.611107c27.923737 27.923725 43.611115 65.79642 43.611115 105.28653l0 0c0 82.23389 -66.66374 148.89763 -148.89763 148.89763l0 0c-82.2339 0 -148.89764 -66.66374 -148.89764 -148.89763z" fill-rule="evenodd"/><path stroke="#ffffff" stroke-width="3.0" stroke-linejoin="round" stroke-linecap="butt" d="m19.790026 168.69029l0 0c0 -82.2339 66.66374 -148.89764 148.89764 -148.89764l0 0c39.490112 0 77.36281 15.687384 105.286514 43.611107c27.923737 27.923725 43.611115 65.79642 43.611115 105.28653l0 0c0 82.23389 -66.66374 148.89763 -148.89763 148.89763l0 0c-82.2339 0 -148.89764 -66.66374 -148.89764 -148.89763z" fill-rule="evenodd"/><path fill="#000000" fill-opacity="0.0" d="m73.50656 109.338585l181.88977 0l0 112.40945l-181.88977 0z" fill-rule="evenodd"/><path fill="#4a86e8" d="m115.1741 136.81046q8.671875 0 15.1875 4.953125q6.53125 4.9375 7.78125 13.53125l-5.421875 0q-1.609375 -6.609375 -6.390625 -10.21875q-4.78125 -3.609375 -11.1875 -3.609375q-9.921875 0 -15.703125 7.046875q-5.78125 7.046875 -5.78125 18.0625q0 10.828125 5.703125 17.984375q5.703125 7.140625 15.78125 7.140625q7.421875 0 12.421875 -5.015625q5.0 -5.03125 5.9375 -13.265625l5.421875 0q-1.203125 10.734375 -7.578125 16.84375q-6.359375 6.09375 -16.171875 6.09375q-12.375 0 -19.671875 -8.40625q-7.28125 -8.40625 -7.28125 -21.375q0 -13.078125 7.359375 -21.421875q7.375 -8.34375 19.59375 -8.34375zm36.953125 1.21875l0 35.734375q0 8.75 4.0625 13.34375q4.0625 4.59375 12.65625 4.59375q8.640625 0 12.71875 -4.53125q4.078125 -4.53125 4.078125 -13.40625l0 -35.734375l5.46875 0l0 36.90625q0 9.453125 -5.671875 15.4375q-5.65625 5.984375 -16.59375 5.984375q-6.671875 0 -11.703125 -2.5q-5.015625 -2.515625 -7.734375 -7.546875q-2.703125 -5.046875 -2.703125 -11.375l0 -36.90625l5.421875 0zm89.38281 0l0 4.640625l-33.984375 0l0 20.625l31.828125 0l0 4.65625l-31.828125 0l0 22.53125l34.375 0l0 4.65625l-39.84375 0l0 -57.109375l39.453125 0z" fill-rule="nonzero"/></g></svg>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns="http://www.w3.org/2000/svg" xmlns:xl="http://www.w3.org/1999/xlink" viewBox="0 0 424 424" width="424" height="424">
<defs/>
<metadata> Produced by OmniGraffle 7.11.2
<dc:date>2019-08-22 22:21:14 +0000</dc:date>
</metadata>
<g id="Canvas_1" stroke="none" stroke-opacity="1" fill-opacity="1" stroke-dasharray="none" fill="none">
<title>Canvas 1</title>
<g id="Canvas_1: Layer 1">
<title>Layer 1</title>
<g id="Group_13">
<g id="Graphic_7">
<path d="M 28.75 212 C 28.75 110.79382 110.79382 28.75 212 28.75 C 260.60093 28.75 307.2113 48.05664 341.5773 82.42268 C 375.94337 116.78873 395.25 163.39908 395.25 212 C 395.25 313.2062 313.2062 395.25 212 395.25 C 110.79382 395.25 28.749998 313.2062 28.749998 212 Z" stroke="white" stroke-linecap="butt" stroke-linejoin="round" stroke-width="6"/>
</g>
<g id="Graphic_9">
<path d="M 9.77383 212 C 9.77383 100.31357 100.31358 9.773825 212 9.773825 C 265.6337 9.773825 317.07074 31.079737 354.9955 69.0045 C 392.92027 106.92927 414.22617 158.3663 414.22617 212 C 414.22617 323.68644 323.68644 414.22618 212 414.22618 C 100.31357 414.22618 9.77383 323.68644 9.77383 212 Z" stroke="white" stroke-linecap="butt" stroke-linejoin="round" stroke-width="20"/>
</g>
<g id="Graphic_4">
<path d="M 128.24941 161.77382 C 137.37563 161.77382 145.36723 164.38014 152.22422 169.59277 C 159.09766 174.78896 163.19212 181.90905 164.50761 190.95304 L 155.9487 190.95304 C 154.25501 183.99739 150.89229 178.62032 145.86054 174.82184 C 140.82879 171.02337 134.94197 169.12413 128.20008 169.12413 C 117.75838 169.12413 109.49545 172.83216 103.41131 180.24824 C 97.32717 187.66432 94.2851 197.16873 94.2851 208.7615 C 94.2851 220.15693 97.28606 229.62023 103.28798 237.15142 C 109.28991 244.66615 117.59394 248.42352 128.20008 248.42352 C 136.0108 248.42352 142.54715 245.78432 147.8091 240.50592 C 153.07107 235.21107 156.19536 228.23075 157.18198 219.56496 L 165.74088 219.56496 C 164.47472 230.86173 160.48714 239.72484 153.77814 246.1543 C 147.08559 252.56732 138.57601 255.77382 128.24941 255.77382 C 115.22606 255.77382 104.8748 251.3505 97.19562 242.50382 C 89.53289 233.65715 85.70152 222.4097 85.70152 208.7615 C 85.70152 194.99818 89.574 183.72607 97.31895 174.94517 C 105.08034 166.16427 115.3905 161.77382 128.24941 161.77382 Z M 186.58318 163.69773 L 186.58318 220.1076 C 186.58318 229.31603 188.72085 236.33746 192.9962 241.17188 C 197.27154 246.0063 203.9312 248.42352 212.9752 248.42352 C 222.06853 248.42352 228.7611 246.0392 233.05288 241.27054 C 237.34466 236.5019 239.49056 229.44758 239.49056 220.1076 L 239.49056 163.69773 L 248.12346 163.69773 L 248.12346 221.9575 C 248.12346 231.9059 245.13894 240.02905 239.1699 246.32696 C 233.2173 252.62487 224.48574 255.77382 212.9752 255.77382 C 205.95378 255.77382 199.79564 254.45833 194.5008 251.82735 C 189.22238 249.17993 185.15259 245.2088 182.2914 239.91395 C 179.44665 234.60265 178.02427 228.61717 178.02427 221.9575 L 178.02427 163.69773 Z M 327.68184 163.69773 L 327.68184 171.02337 L 274.0345 171.02337 L 274.0345 203.58175 L 324.278 203.58175 L 324.278 210.93205 L 274.0345 210.93205 L 274.0345 246.49962 L 328.29848 246.49962 L 328.29848 253.84992 L 265.4016 253.84992 L 265.4016 163.69773 Z" fill="white"/>
</g>
</g>
</g>
</g>
</svg>
@@ -0,0 +1,44 @@
/*
Add styles or override variables from the theme here.
*/
$enable-rounded: true;

$display1-weight: 500 !default;
$display2-weight: 100 !default;


$primary:#2D70DE !default;
$primary-light: white !default;
$secondary: #2D70DE !default;
$light: rgb(255, 255,255) !default;
$grey: #888 !default;

.nav-shadow {
box-shadow: 0 2px 2px -2px rgba(0,0,0,.2);
}

.navbar-brand {
color: white !important
}

.navbar-bg-onscroll {
box-shadow: 0 2px 2px -2px rgba(0,0,0,.2);
#agones-top {
display: block !important;
}
}

.control-bar {
display: none;
}

#community a {
// color: #121314 !important;
color: #2D70DE;
}

#community {
// color: #121314 !important;
color: #2D70DE;
}

@@ -36,7 +36,7 @@ pygmentsStyle = "tango"
url = "/docs/"
[[menu.main]]
name = "GitHub"
weight = -99
weight = 100
url = "https://github.com/cuelang/cue"

# Configure how URLs look like per section.
@@ -83,7 +83,7 @@ privacy_policy = "https://policies.google.com/privacy"
version_menu = "Releases"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/cuelang/website"
github_repo = "https://github.com/cuelang/cue"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/cuelang/cue"

@@ -116,14 +116,22 @@ navbar_logo = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "GitHub"
url = "https://github.com/cuelang/cue"
icon = "fab fa-github"
desc = "Development takes place here!"
[[params.links.user]]
name = "Slack"
url = "https://cuelang.slack.com"
icon = "fab fa-slack"
desc = "Chat with other cue enthusiast"

[[params.links.developer]]
name = "GitHub"
url = "https://github.com/cuelang/cue"
icon = "fab fa-github"
desc = "Development takes place here!"

[[params.links.developer]]
name = "Gerrit"
url = "https://cue.googlesource.com/cue"
icon = "fab fa-git"
desc = "The source-of-truth repo!"

# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
@@ -1,83 +1,110 @@
+++
title = "Goldydocs"
linkTitle = "Goldydocs"

title = "CUE"
linkTitle = "CUE"
+++

{{< blocks/cover title="Welcome to Goldydocs: A Docsy Example Project!" image_anchor="top" height="full" color="orange" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy-example">
Download <i class="fab fa-github ml-2 "></i>
</a>
<p class="lead mt-5">Porridge temperature assessment - in the cloud!</p>
<div class="mx-auto mt-5">
{{< blocks/link-down color="info" >}}
{{< blocks/cover title="" image_anchor="top" height="min" color="light" >}}
<div class="col-lg-6">
<h3>
<img alt="CUE" width="130" src="images/cue.svg" />
Configure Unify Execute
</h3>
<p class="display-2 mt-3 mb-0">
Validate, define, and use dynamic and text-based data</p>
<div class="pt-3 mt-3 lead text-center">
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/cuelang/cue/releases">
Download <i class="fab fa-github ml-2 "></i>
</a>
</div>
</div>
</div>
<div class="col-lg-6 mt-5 mt-lg-3 d-sm-block" style="display: none">
<asciinema-player
loop autoplay speed=2 font-size="12px" rows=17 cols=80
src="cue.cast"></asciinema-player>
</div>
<div class="col-12 pt-3">
<div class="pt-3 lead text-center">
<div class="mx-auto">
<p class="lead mt-3">Be in control of your data</p>
<div class="mx-auto mt-3">
{{< blocks/link-down color="light-secondary" >}}
</div>
</div>
</div>
</div>
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}}
Goldydocs provides a single web UI providing visibility into porridge temperature, chair size, and bed softness metrics! You can even find out who's been eating **your** porridge.
{{% blocks/lead color="secondary" %}}
**CUE** is an open source language, with a rich set APIs and
tooling, for defining, generating, and validating all kinds of data:
configuration, APIs, database schemas, code, ... you name it.



(Sadly, Goldydocs isn't a real project, but you can use this site as an example to create your own real websites with [Docsy](http://docsy.dev))
{{% /blocks/lead %}}


{{< blocks/section color="dark" >}}
{{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}}
The Goldydocs UI now shows chair size metrics by default.

Please follow this space for updates!
{{% blocks/feature icon="fa-check-circle" title="Data Validation" url="./docs/usecases/validation/" %}}
Validate text-based data files or programmatic data such
as incoming RPCs or database documents.
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% blocks/feature icon="fa-list-alt" title="Configuration" url="./docs/usecases/configuration/" %}}
Just add validation to existing data (CUE, YAML, JSON),
reduce boilerplate in large-scale configurations, or both.
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
For announcement of latest features etc.
<!--
life-ring map newspaper pause-circle play-circle stop-circle user clipboard comments (two bubbles) file-alt file-code handshake map -->
{{% blocks/feature icon="fa-handshake" title="Data Definition" url="./docs/usecases/datadef/" %}}
Define schema to communicate an API or standard.
{{% /blocks/feature %}}


{{< /blocks/section >}}


{{< blocks/section >}}
<div class="col">
<h1 class="text-center">This is the second Section</h1>
</div>

{{< /blocks/section >}}



{{< blocks/section >}}
{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
Get the Goldydocs app!
{{% blocks/feature icon="fa-file-code" title="Generate Code and Schema" url="./docs/usecases/generate/" %}}
Keep validation code in sync across code bases,
Protobuf definitions, and OpenAPI definitions.
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/gohugoio/hugo" %}}
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% blocks/feature icon="fas fa-wrench" title="Scripting" url="./docs/usecases/scripting/" %}}
Automate the use of your data without writing yet another tool.
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}}
For announcement of latest features etc.
{{% blocks/feature icon="fa-question-circle" title="Querying" url="./docs/usecases/query/" %}}
Find the locations of instances of CUE types and values in data.<br>
Coming soon.
{{% /blocks/feature %}}


{{< /blocks/section >}}

{{< blocks/section >}}

<div class="col-12">
<h1 class="text-center">This is another Section</h1>
{{< blocks/section color="white" >}}
<!--
<div class="col">
<h2 class="text-left">Projects using CUE</h1>
<img alt="k8s" height="90" src="images/istio.png"/>
</div>
-->
<div class="col">
<h2 class="text-left">Featured Integrations</h1>
{{<imglink ref="json" height="70" src="json.svg" >}}&emsp;&emsp;
{{<imglink ref="yaml" height="50" src="yaml.png" >}}&emsp;&emsp;
{{<imglink ref="go" height="160" src="go.png" >}}
{{<imglink ref="protobuf" height="200" src="protobuf_nano.png" >}}
{{<imglink ref="openapi" height="70" src="openapi-wide.svg" >}}&emsp;&emsp;&emsp;
{{<imglink ref="k8s" height="80" src="k8s.svg" >}}&emsp;&emsp;
</div>

{{< /blocks/section >}}

@@ -0,0 +1,6 @@
---
title: Community
menu:
main:
weight: 40
---
@@ -0,0 +1,5 @@
+++
title = "Documentation"
description = "More about what CUE is and how to use it."
+++

0 comments on commit 7f99772

Please sign in to comment.
You can’t perform that action at this time.