Updating docs to split functions by namespace

Signed-off-by: Dave Henderson <dhenderson@gmail.com>
hairyhenderson · Jun 9, 2017 · d8f2a93 · d8f2a93
1 parent b580bba
commit d8f2a93
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 100 deletions.
diff --git a/docs/config.toml b/docs/config.toml
@@ -4,7 +4,6 @@ title = "gomplate documentation"
 
 theme = "hugo-material-docs"
 
-
 [params]
   author = "hairyhenderson"
   description = "gomplate documentation"
@@ -19,33 +18,3 @@ theme = "hugo-material-docs"
 [social]
   twitter = "hairyhenderson"
   github  = "hairyhenderson"
-
-[[menu.main]]
-  name   = "About"
-  url    = "/"
-  weight = 1
-  pre    = ""
-
-[[menu.main]]
-  name   = "Installing"
-  url    = "installing/"
-  weight = 10
-  pre    = ""
-
-[[menu.main]]
-  name   = "Usage"
-  url    = "usage/"
-  weight = 11
-  pre    = ""
-
-[[menu.main]]
-  name   = "Syntax"
-  url    = "syntax/"
-  weight = 12
-  pre    = ""
-
-[[menu.main]]
-  name   = "Built-in Functions"
-  url    = "functions/"
-  weight = 13
-  pre    = ""
diff --git a/docs/content/functions/aws.md b/docs/content/functions/aws.md
@@ -0,0 +1,75 @@
+---
+title: aws functions
+menu:
+  main:
+    parent: functions
+---
+
+
+## `aws.EC2Meta`
+
+**Alias:** _(to be deprecated)_ `ec2meta`
+
+Queries AWS [EC2 Instance Metadata](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) for information. This only retrieves data in the `meta-data` path -- for data in the `dynamic` path use `aws.EC2Dynamic`.
+
+This only works when running `gomplate` on an EC2 instance. If the EC2 instance metadata API isn't available, the tool will timeout and fail.
+
+#### Example
+
+```console
+$ echo '{{aws.EC2Meta "instance-id"}}' | gomplate
+i-12345678
+```
+
+## `aws.EC2Dynamic`
+
+**Alias:** _(to be deprecated)_ `ec2dynamic`
+
+Queries AWS [EC2 Instance Dynamic Metadata](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) for information. This only retrieves data in the `dynamic` path -- for data in the `meta-data` path use `aws.EC2Meta`.
+
+This only works when running `gomplate` on an EC2 instance. If the EC2 instance metadata API isn't available, the tool will timeout and fail.
+
+#### Example
+
+```console
+$ echo '{{ (aws.EC2Dynamic "instance-identity/document" | json).region }}' | ./gomplate
+us-east-1
+```
+
+## `aws.EC2Region`
+
+**Alias:** _(to be deprecated)_ `ec2region`
+
+Queries AWS to get the region. An optional default can be provided, or returns
+`unknown` if it can't be determined for some reason.
+
+#### Example
+
+_In EC2_
+```console
+$ echo '{{ aws.EC2Region }}' | ./gomplate
+us-east-1
+```
+_Not in EC2_
+```console
+$ echo '{{ aws.EC2Region }}' | ./gomplate
+unknown
+$ echo '{{ aws.EC2Region "foo" }}' | ./gomplate
+foo
+```
+
+## `aws.EC2Tag`
+
+**Alias:** _(to be deprecated)_ `ec2tag`
+
+Queries the AWS EC2 API to find the value of the given [user-defined tag](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html). An optional default
+can be provided.
+
+#### Example
+
+```console
+$ echo 'This server is in the {{ aws.EC2Tag "Account" }} account.' | ./gomplate
+foo
+$ echo 'I am a {{ aws.EC2Tag "classification" "meat popsicle" }}.' | ./gomplate
+I am a meat popsicle.
+```
diff --git a/docs/content/functions.md → docs/content/functions/general.md b/docs/content/functions.md → docs/content/functions/general.md
@@ -1,12 +1,10 @@
 ---
-title: Built-in functions
-weight: 0
+title: other functions
+menu:
+  main:
+    parent: functions
 ---
 
-In addition to all of the functions and operators that the [Go template](https://golang.org/pkg/text/template/)
-language provides (`if`, `else`, `eq`, `and`, `or`, `range`, etc...), there are
-some additional functions baked in to `gomplate`:
-
 ## `contains`
 
 Contains reports whether the second string is contained within the first. Equivalent to
@@ -814,63 +812,3 @@ $ gomplate -d person.json -f input.tmpl
   ]
 }
 ```
-
-## `ec2meta`
-
-Queries AWS [EC2 Instance Metadata](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) for information. This only retrieves data in the `meta-data` path -- for data in the `dynamic` path use `ec2dynamic`.
-
-This only works when running `gomplate` on an EC2 instance. If the EC2 instance metadata API isn't available, the tool will timeout and fail.
-
-#### Example
-
-```console
-$ echo '{{ec2meta "instance-id"}}' | gomplate
-i-12345678
-```
-
-## `ec2dynamic`
-
-Queries AWS [EC2 Instance Dynamic Metadata](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) for information. This only retrieves data in the `dynamic` path -- for data in the `meta-data` path use `ec2meta`.
-
-This only works when running `gomplate` on an EC2 instance. If the EC2 instance metadata API isn't available, the tool will timeout and fail.
-
-#### Example
-
-```console
-$ echo '{{ (ec2dynamic "instance-identity/document" | json).region }}' | ./gomplate
-us-east-1
-```
-
-## `ec2region`
-
-Queries AWS to get the region. An optional default can be provided, or returns
-`unknown` if it can't be determined for some reason.
-
-#### Example
-
-_In EC2_
-```console
-$ echo '{{ ec2region }}' | ./gomplate
-us-east-1
-```
-_Not in EC2_
-```console
-$ echo '{{ ec2region }}' | ./gomplate
-unknown
-$ echo '{{ ec2region "foo" }}' | ./gomplate
-foo
-```
-
-## `ec2tag`
-
-Queries the AWS EC2 API to find the value of the given [user-defined tag](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html). An optional default
-can be provided.
-
-#### Example
-
-```console
-$ echo 'This server is in the {{ ec2tag "Account" }} account.' | ./gomplate
-foo
-$ echo 'I am a {{ ec2tag "classification" "meat popsicle" }}.' | ./gomplate
-I am a meat popsicle.
-```
diff --git a/docs/content/index.md b/docs/content/index.md
@@ -1,7 +1,10 @@
 ---
 title: gomplate
 type: index
-weight: 0
+weight: 1
+menu:
+  main:
+    name: About
 ---
 
 A [Go template](https://golang.org/pkg/text/template/)-based CLI tool. `gomplate` can be used as an alternative to

diff --git a/docs/content/installing.md b/docs/content/installing.md
@@ -1,6 +1,7 @@
 ---
 title: Installing
 weight: 10
+menu: main
 ---
 # Installing
 

diff --git a/docs/content/syntax.md b/docs/content/syntax.md
@@ -1,6 +1,7 @@
 ---
 title: Syntax
-weight: 0
+weight: 12
+menu: main
 ---
 
 ## About `.Env`
@@ -13,3 +14,9 @@ Sometimes, this behaviour is desired; if the output is unusable without certain
 strings, this is a sure way to know that variables are missing!
 
 If you want different behaviour, try [`getenv`](../functions/#getenv).
+
+## Built-in functions
+
+In addition to all of the functions and operators that the [Go template](https://golang.org/pkg/text/template/)
+language provides (`if`, `else`, `eq`, `and`, `or`, `range`, etc...), there are
+some additional functions baked in to `gomplate`. See the links on the left.
diff --git a/docs/content/usage.md b/docs/content/usage.md
@@ -1,6 +1,7 @@
 ---
 title: Usage
-weight: 0
+weight: 11
+menu: main
 ---
 
 The simplest usage of `gomplate` is to just replace environment