From 8196fae7bcfd55c0eaab02eaf25d3be6565b6e68 Mon Sep 17 00:00:00 2001 From: Cody Soyland Date: Wed, 11 Jul 2018 12:15:15 -0500 Subject: [PATCH 1/2] Rename WebUI to Console, update installation instructions. --- docs/{webui.md => console.md} | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) rename docs/{webui.md => console.md} (62%) diff --git a/docs/webui.md b/docs/console.md similarity index 62% rename from docs/webui.md rename to docs/console.md index a07132852..22556591b 100644 --- a/docs/webui.md +++ b/docs/console.md @@ -1,42 +1,44 @@ +++ -title = "WebUI" +title = "Console" weight = 9 nav = [ - "Console", + "Installation", + "Query", "Cluster Admin", ] +++ -## WebUI +## Console -A web-based app called Pilosa WebUI is available in a separate package. This can be used for constructing queries and viewing the cluster status. +A web-based app called Pilosa Console is available in a separate package. This can be used for constructing queries and viewing the cluster status. ### Installation -Releases are [available on Github](https://github.com/pilosa/webui/releases) as well as on [Homebrew](https://brew.sh/) for Mac. +Releases are [available on Github](https://github.com/pilosa/console/releases) as well as on [Homebrew](https://brew.sh/) for Mac. Installing on a Mac with Homebrew is simple; just run: ``` -brew install pilosa-webui +brew tap pilosa/homebrew-pilosa +brew install pilosa-console ``` -You may also build from source by checking out the [repo on Github](https://github.com/pilosa/webui) and running: +You may also build from source by checking out the [repo on Github](https://github.com/pilosa/console) and running: ``` make install ``` -### Console +### Query -The Console view allows you to enter [PQL](../query-language/) queries and run them against your locally running server. First you must select an Index with the Select index dropdown. +The Query tab allows you to enter [PQL](../query-language/) queries and run them against your locally running server. First you must select an Index with the Select index dropdown. Each query's result will be displayed in the Output section along with the query time. The Console will keep a record of each query and its result with the latest query on top. ![webUI console screenshot](/img/docs/webui-console.png) -*WebUI console screenshot* +*Console query screenshot* In addition to standard PQL, the console supports a few special commands, prefixed with `:`. From 42c935395b21d65ecb73077824a4713bb3b992e1 Mon Sep 17 00:00:00 2001 From: Cody Soyland Date: Wed, 11 Jul 2018 12:30:39 -0500 Subject: [PATCH 2/2] Update alt text --- docs/console.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/console.md b/docs/console.md index 22556591b..18c6a89c4 100644 --- a/docs/console.md +++ b/docs/console.md @@ -37,7 +37,7 @@ Each query's result will be displayed in the Output section along with the query The Console will keep a record of each query and its result with the latest query on top. -![webUI console screenshot](/img/docs/webui-console.png) +![Console screenshot](/img/docs/webui-console.png) *Console query screenshot* In addition to standard PQL, the console supports a few special commands, prefixed with `:`.