From 370ab656f9096651fe8f4a6ad68bb12f5266b6dd Mon Sep 17 00:00:00 2001 From: Cody Soyland Date: Mon, 14 Aug 2017 16:05:03 -0500 Subject: [PATCH 1/2] Add metadata to doc pages (sort weight and nav headings) --- docs/administration.md | 11 +++++++++-- docs/api-reference.md | 2 ++ docs/client-libraries.md | 6 ++++++ docs/configuration.md | 7 +++++++ docs/data-model.md | 12 ++++++++++++ docs/faq.md | 2 ++ docs/getting-started.md | 7 +++++++ docs/glossary.md | 2 ++ docs/input-definition.md | 11 ++++++++--- docs/installation.md | 5 +++++ docs/introduction.md | 2 ++ docs/pdk.md | 5 +++++ docs/query-language.md | 7 +++++++ docs/tutorials.md | 5 +++++ docs/webui.md | 5 +++++ 15 files changed, 84 insertions(+), 5 deletions(-) diff --git a/docs/administration.md b/docs/administration.md index 04b1b2bf0..786f10992 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -1,5 +1,12 @@ +++ -title = "Administration Guide" +title = "Administration" +weight = 13 +nav = [ + "Installing in production", + "Imports and Exports", + "Versioning", + "Backup/restore", +] +++ ## Administration Guide @@ -164,4 +171,4 @@ We currently track the following events Goroutines: Number of running Goroutines. -OpenFiles: Number of open file handles associated with running Pilosa process ID. \ No newline at end of file +OpenFiles: Number of open file handles associated with running Pilosa process ID. diff --git a/docs/api-reference.md b/docs/api-reference.md index 0ee460562..c14ff4dcc 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -1,5 +1,7 @@ +++ title = "API Reference" +weight = 10 +nav = [] +++ diff --git a/docs/client-libraries.md b/docs/client-libraries.md index e7a439371..e896fbab4 100644 --- a/docs/client-libraries.md +++ b/docs/client-libraries.md @@ -1,5 +1,11 @@ +++ title = "Client Libraries" +weight = 12 +nav = [ + "Go", + "Python", + "Java", +] +++ ## Client Libraries diff --git a/docs/configuration.md b/docs/configuration.md index 08ff7c4a3..2ef18a532 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,5 +1,12 @@ +++ title = "Configuration" +weight = 7 +nav = [ + "Command line flags", + "Environment variables", + "Config file", + "All Options", +] +++ ## Configuration diff --git a/docs/data-model.md b/docs/data-model.md index f8987f87b..2e7ac03e8 100644 --- a/docs/data-model.md +++ b/docs/data-model.md @@ -1,5 +1,17 @@ +++ title = "Data Model" +weight = 5 +nav = [ + "Overview", + "Index", + "Column", + "Row", + "Frame", + "Time Quantum", + "Attribute", + "Slice", + "View", +] +++ ## Data Model diff --git a/docs/faq.md b/docs/faq.md index cea161aa3..ef9f8bfc8 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,7 @@ +++ title = "FAQ" +weight = 15 +nav = [] +++ ## FAQ diff --git a/docs/getting-started.md b/docs/getting-started.md index 0c42683e9..534e733b4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,5 +1,12 @@ +++ title = "Getting Started" +weight = 3 +nav = [ + "Starting Pilosa", + "Sample Project", + "Input Definition", + "What's Next?", +] +++ ## Getting Started diff --git a/docs/glossary.md b/docs/glossary.md index e4bef02e3..50906a0cf 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -1,5 +1,7 @@ +++ title = "Glossary" +weight = 14 +nav = [] +++ ## Glossary diff --git a/docs/input-definition.md b/docs/input-definition.md index 4b73c4991..459f1752d 100644 --- a/docs/input-definition.md +++ b/docs/input-definition.md @@ -1,12 +1,17 @@ +++ title = "Input Definition" +weight = 8 +nav = [ + "Create the Schema", + "Import Data", +] +++ ## Input Definition This document builds on the data import concepts introduced in [Getting Started](../getting-started/). Here we will demonstrate creating the index's schema and data definition. Then using this definition to import JSON data. -#### Create the Schema Using an Input Definition +### Create the Schema Input definitions allow users to define a schema based on their data and to provide data to Pilosa in a more standard format like JSON. Once an input definition is created, we can send data to Pilosa as JSON, and as long as the data adheres to the definition, Pilosa will internally perform all of the appropriate mutations. @@ -91,7 +96,7 @@ We can also set `repo_id` for multiple frames at the same time by providing fiel - mapping: The value for this field is used to lookup a `rowID` in a map. A valueMap is required for this destination type. - set-timestamp: The value for this field is used to lookup timestamp and set timestamp for the whole frame -#### Import Data Using an Input Definition +### Import Data The sample data for the "Star Trace" project is at [Pilosa Getting Started repository](https://github.com/pilosa/getting-started). @@ -125,4 +130,4 @@ curl localhost:10101/index/repository/query \ SetBit(frame="language", repo_id=91720568, language_id=5) SetBit(frame="language", repo_id=95122322, language_id=17) ' -``` \ No newline at end of file +``` diff --git a/docs/installation.md b/docs/installation.md index 9936fb95c..b6c81a2b4 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,10 @@ +++ title = "Installation" +weight = 2 +nav = [ + "Installing on MacOS", + "Installing on Linux", +] +++ diff --git a/docs/introduction.md b/docs/introduction.md index 87cd94a3c..d499c8c0a 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,5 +1,7 @@ +++ title = "Introduction" +weight = 1 +nav = [] +++ diff --git a/docs/pdk.md b/docs/pdk.md index 5d50a5b98..8c02dc279 100644 --- a/docs/pdk.md +++ b/docs/pdk.md @@ -1,5 +1,10 @@ +++ title = "PDK" +weight = 11 +nav = [ + "Library", + "Examples", +] +++ ## PDK diff --git a/docs/query-language.md b/docs/query-language.md index 93ddb846a..c9d5f1e05 100644 --- a/docs/query-language.md +++ b/docs/query-language.md @@ -1,5 +1,12 @@ +++ title = "Query Language" +weight = 6 +nav = [ + "Conventions", + "Arguments and Types", + "Write Operations", + "Read Operations", +] +++ ## Query Language diff --git a/docs/tutorials.md b/docs/tutorials.md index 350aa3849..995673ca2 100644 --- a/docs/tutorials.md +++ b/docs/tutorials.md @@ -1,5 +1,10 @@ +++ title = "Tutorials" +weight = 4 +nav = [ + "Transportation", + "Chemical similarity search", +] +++ ## Tutorials diff --git a/docs/webui.md b/docs/webui.md index 8084cbb80..1e123393f 100644 --- a/docs/webui.md +++ b/docs/webui.md @@ -1,5 +1,10 @@ +++ title = "WebUI" +weight = 9 +nav = [ + "Console", + "Cluster Admin", +] +++ ## WebUI From 463c3029f2ff09fc388f7675816b91d023c778be Mon Sep 17 00:00:00 2001 From: Cody Soyland Date: Wed, 16 Aug 2017 11:39:57 -0500 Subject: [PATCH 2/2] Add sorting and navigation metadata for architecture document --- docs/architecture.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/architecture.md b/docs/architecture.md index 0ff35565c..5cc5ff6ee 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,5 +1,7 @@ +++ title = "Architecture" +weight = 6 +nav = [] +++ ## Architecture