From ebdc092688f8bb27ee6ac242135b40da4b56dd7b Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Tue, 12 Jun 2018 10:16:54 +1000 Subject: [PATCH] Updating user docs --- README.md | 8 +++++--- docs/index.html | 6 ++++++ docs/search/search_index.json | 4 ++-- docs/sitemap.xml | 14 +++++++------- mkdocs/index.md | 6 ++++++ 5 files changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e7ab000b..939e7f91 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,8 @@ Use "yq [command] --help" for more information about a command. 2. add unit tests 3. apply changes 4. `make [local] build` -5. Update user documentation if required (README.md, mkdocs folder ) -6. `make [local] build-docs` -5. profit +5. If required, update the user documentation + - Update README.md and/or documentation under the mkdocs folder + - `make [local] build-docs` + - browse to docs/index.html and check your changes +6. profit diff --git a/docs/index.html b/docs/index.html index 34111b66..dcac68cb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -373,6 +373,12 @@
snap install yq
 
+

On Ubuntu 16.04 or higher from Debian package:

+
sudo add-apt-repository ppa:rmescandon/yq
+sudo apt update
+sudo apt install yq -y
+
+

or, Download latest binary or alternatively:

go get github.com/mikefarah/yq
 
diff --git a/docs/search/search_index.json b/docs/search/search_index.json index 6fd64084..a9bbcaae 100644 --- a/docs/search/search_index.json +++ b/docs/search/search_index.json @@ -2,7 +2,7 @@ "docs": [ { "location": "/", - "text": "yq\n\u00b6\n\n\nyq is a lightweight and portable command-line YAML processor\n\n\nThe aim of the project is to be the \njq\n or sed of yaml files.\n\n\nInstall\n\u00b6\n\n\nOn MacOS:\n\n\nbrew install yq\n\n\n\n\nOn Ubuntu and other Linux distros supporting \nsnap\n packages:\n\n\nsnap install yq\n\n\n\n\nor, \nDownload latest binary\n or alternatively:\n\n\ngo get github.com/mikefarah/yq\n\n\n\n\nView on GitHub", + "text": "yq\n\u00b6\n\n\nyq is a lightweight and portable command-line YAML processor\n\n\nThe aim of the project is to be the \njq\n or sed of yaml files.\n\n\nInstall\n\u00b6\n\n\nOn MacOS:\n\n\nbrew install yq\n\n\n\n\nOn Ubuntu and other Linux distros supporting \nsnap\n packages:\n\n\nsnap install yq\n\n\n\n\nOn Ubuntu 16.04 or higher from Debian package:\n\n\nsudo add-apt-repository ppa:rmescandon/yq\nsudo apt update\nsudo apt install yq -y\n\n\n\n\nor, \nDownload latest binary\n or alternatively:\n\n\ngo get github.com/mikefarah/yq\n\n\n\n\nView on GitHub", "title": "Install" }, { @@ -12,7 +12,7 @@ }, { "location": "/#install", - "text": "On MacOS: brew install yq On Ubuntu and other Linux distros supporting snap packages: snap install yq or, Download latest binary or alternatively: go get github.com/mikefarah/yq View on GitHub", + "text": "On MacOS: brew install yq On Ubuntu and other Linux distros supporting snap packages: snap install yq On Ubuntu 16.04 or higher from Debian package: sudo add-apt-repository ppa:rmescandon/yq\nsudo apt update\nsudo apt install yq -y or, Download latest binary or alternatively: go get github.com/mikefarah/yq View on GitHub", "title": "Install" }, { diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 736dac6d..a583a85d 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -4,7 +4,7 @@ / - 2018-05-07 + 2018-06-12 daily @@ -12,7 +12,7 @@ /read/ - 2018-05-07 + 2018-06-12 daily @@ -20,7 +20,7 @@ /write/ - 2018-05-07 + 2018-06-12 daily @@ -28,7 +28,7 @@ /delete/ - 2018-05-07 + 2018-06-12 daily @@ -36,7 +36,7 @@ /create/ - 2018-05-07 + 2018-06-12 daily @@ -44,7 +44,7 @@ /convert/ - 2018-05-07 + 2018-06-12 daily @@ -52,7 +52,7 @@ /merge/ - 2018-05-07 + 2018-06-12 daily diff --git a/mkdocs/index.md b/mkdocs/index.md index e4beb998..cf186774 100644 --- a/mkdocs/index.md +++ b/mkdocs/index.md @@ -12,6 +12,12 @@ On Ubuntu and other Linux distros supporting `snap` packages: ``` snap install yq ``` +On Ubuntu 16.04 or higher from Debian package: +``` +sudo add-apt-repository ppa:rmescandon/yq +sudo apt update +sudo apt install yq -y +``` or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively: ``` go get github.com/mikefarah/yq