Merge pull request #775 from codysoyland/doc-metadata

Doc metadata
This commit is contained in:
Cody Soyland 2017-08-16 12:11:33 -05:00 • committed by GitHub
commit e304d00c41
16 changed files with 86 additions and 5 deletions

View file

@ -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
<strong id="goroutines">Goroutines:</strong> Number of running Goroutines.
<strong id="openfiles">OpenFiles:</strong> Number of open file handles associated with running Pilosa process ID.
<strong id="openfiles">OpenFiles:</strong> Number of open file handles associated with running Pilosa process ID.

View file

@ -1,5 +1,7 @@
+++
title = "API Reference"
weight = 10
nav = []
+++

View file

@ -1,5 +1,7 @@
+++
title = "Architecture"
weight = 6
nav = []
+++
## Architecture

View file

@ -1,5 +1,11 @@
+++
title = "Client Libraries"
weight = 12
nav = [
"Go",
"Python",
"Java",
]
+++
## Client Libraries

View file

@ -1,5 +1,12 @@
+++
title = "Configuration"
weight = 7
nav = [
"Command line flags",
"Environment variables",
"Config file",
"All Options",
]
+++
## Configuration

View file

@ -1,5 +1,17 @@
+++
title = "Data Model"
weight = 5
nav = [
"Overview",
"Index",
"Column",
"Row",
"Frame",
"Time Quantum",
"Attribute",
"Slice",
"View",
]
+++
## Data Model

View file

@ -1,5 +1,7 @@
+++
title = "FAQ"
weight = 15
nav = []
+++
## FAQ

View file

@ -1,5 +1,12 @@
+++
title = "Getting Started"
weight = 3
nav = [
"Starting Pilosa",
"Sample Project",
"Input Definition",
"What's Next?",
]
+++
## Getting Started

View file

@ -1,5 +1,7 @@
+++
title = "Glossary"
weight = 14
nav = []
+++
## Glossary

View file

@ -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)
'
```
```

View file

@ -1,5 +1,10 @@
+++
title = "Installation"
weight = 2
nav = [
"Installing on MacOS",
"Installing on Linux",
]
+++

View file

@ -1,5 +1,7 @@
+++
title = "Introduction"
weight = 1
nav = []
+++

View file

@ -1,5 +1,10 @@
+++
title = "PDK"
weight = 11
nav = [
"Library",
"Examples",
]
+++
## PDK

View file

@ -1,5 +1,12 @@
+++
title = "Query Language"
weight = 6
nav = [
"Conventions",
"Arguments and Types",
"Write Operations",
"Read Operations",
]
+++
## Query Language

View file

@ -1,5 +1,10 @@
+++
title = "Tutorials"
weight = 4
nav = [
"Transportation",
"Chemical similarity search",
]
+++
## Tutorials

View file

@ -1,5 +1,10 @@
+++
title = "WebUI"
weight = 9
nav = [
"Console",
"Cluster Admin",
]
+++
## WebUI