diff --git a/README.md b/README.md index e7ab000..939e7f9 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 34111b6..dcac68c 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 6fd6408..a9bbcaa 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 736dac6..a583a85 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -4,7 +4,7 @@