first commit to the influxdb 2.0 docs!
Scott Anderson
commit
483c32c6bb
|
|
@ -0,0 +1,19 @@
|
||||||
|
# Contributing to InfluxData Documentation
|
||||||
|
|
||||||
|
We welcome (and encourage!) contributions from the community.
|
||||||
|
|
||||||
|
- Sign the [InfluxData Contributor License Agreement (CLA)](https://www.influxdata.com/legal/cla/).
|
||||||
|
|
||||||
|
- [Downlaod and install Hugo](http://gohugo.io/overview/installing/).
|
||||||
|
- Fork this repository on GitHub.
|
||||||
|
- Clone the repo to your local computer.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/your_username/docs.influxdata.com.git
|
||||||
|
cd docs.influxdata.com/
|
||||||
|
```
|
||||||
|
- Make your changes.
|
||||||
|
- Make sure the site compiles locally with `hugo server --watch`.
|
||||||
|
- Check it out at [localhost:1313](http://localhost:1313/).
|
||||||
|
- Submit a pull request.
|
||||||
|
- Earn the respect, admiration, and eternal love of the entire InfluxData community.
|
||||||
|
|
@ -0,0 +1,87 @@
|
||||||
|
# InfluxDB v2.0 Documentation
|
||||||
|
This is the repository represents the InfluxDB v2.x documentation that will be
|
||||||
|
accessible at [docs.influxdata.com](https://docs.influxdata.com).
|
||||||
|
|
||||||
|
## Run the docs locally
|
||||||
|
|
||||||
|
### Install Hugo
|
||||||
|
Hugo is the static site generator used to build the InfluxData documentation.
|
||||||
|
[Download and install Hugo](https://gohugo.io/getting-started/installing/) to run the docs locally.
|
||||||
|
|
||||||
|
### Fork and clone the docs repository
|
||||||
|
[Fork this repository](https://help.github.com/articles/fork-a-repo/) and [clone it](https://help.github.com/articles/cloning-a-repository/) to your local machine.
|
||||||
|
|
||||||
|
### Start the hugo server
|
||||||
|
Hugo provides a local development server that generates the HTML pages and serves them
|
||||||
|
at `localhost:1313`.
|
||||||
|
|
||||||
|
Start the hugo server with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hugo server
|
||||||
|
```
|
||||||
|
|
||||||
|
View the docs at [localhost:1313](http://localhost:1313).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
See our [Contribution guidelines](blob/master/CONTRIBUTING.md) for information
|
||||||
|
about contributing to the InfluxData documentation.
|
||||||
|
|
||||||
|
## Style & Formatting
|
||||||
|
|
||||||
|
### Markdown
|
||||||
|
All of our documentation is written in [Markdown](https://en.wikipedia.org/wiki/Markdown).
|
||||||
|
|
||||||
|
### Semantic Linefeeds
|
||||||
|
Use [semantic linefeeds](http://rhodesmill.org/brandon/2012/one-sentence-per-line/).
|
||||||
|
Separating each sentence with a new line makes it easy to parse diffs with the human eye.
|
||||||
|
|
||||||
|
**Diff without semantic linefeeds:**
|
||||||
|
``` diff
|
||||||
|
-Data are taking off. Those data are time series. You need a database that specializes in time series. You should check out InfluxDB.
|
||||||
|
+Data are taking off. Those data are time series. You need a database that specializes in time series. You need InfluxDB.
|
||||||
|
```
|
||||||
|
|
||||||
|
**Diff with semantic linefeeds:**
|
||||||
|
``` diff
|
||||||
|
Data are taking off.
|
||||||
|
Those data are time series.
|
||||||
|
You need a database that specializes in time series.
|
||||||
|
-You should check out InfluxDB.
|
||||||
|
+You need InfluxDB.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Page frontmatter
|
||||||
|
Every documentation page includes frontmatter which specifies information about the page.
|
||||||
|
Frontmatter populates variables in page templates and the site's navigation menu.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
title: # Title of the page used in the the page's h1
|
||||||
|
seotitle: # Page title used in the html <head> title and used in search engine results
|
||||||
|
description: # Page description displayed in search engine results
|
||||||
|
menu:
|
||||||
|
v2_0:
|
||||||
|
name: # Article name that only appears in the left nav
|
||||||
|
parent: # Specifies a parent group and nests navigation items
|
||||||
|
weight: # Determines sort order.
|
||||||
|
draft: # If true, will not render page on build
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Title usage
|
||||||
|
|
||||||
|
##### `title`
|
||||||
|
The `title` frontmatter populates each page's h1 header.
|
||||||
|
It shouldn't be overly long, but should set the context for users coming from outside sources.
|
||||||
|
|
||||||
|
##### `seotitle`
|
||||||
|
The `seotitle` frontmatter populates each page's HTML `title` attribute.
|
||||||
|
Search engines use this in search results (not the page's h1) and therefore it should be keyword optimized.
|
||||||
|
|
||||||
|
##### `menu > name`
|
||||||
|
The `name` attribute under the `menu` frontmatter determines the text used in each page's link in the site navigation.
|
||||||
|
It should be short and assume the context of its parent if it has one.
|
||||||
|
|
||||||
|
### Article headings
|
||||||
|
Use only h2-h6 headings in markdown content.
|
||||||
|
h1 headings act as the page title and are populated automatically from the `title` frontmatter.
|
||||||
|
h2-h6 headings act as section headings.
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
baseURL = "http://docs.influxdata.com/"
|
||||||
|
languageCode = "en-us"
|
||||||
|
title = "InfluxDB Documentation"
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
---
|
||||||
|
title: InfluxDB v2.0
|
||||||
|
seotitle: This is the SEO title for InfluxDB v2.0
|
||||||
|
description: placeholder
|
||||||
|
menu: v2_0
|
||||||
|
---
|
||||||
|
|
||||||
|
_This placeholder content for the landing page for v2.0._
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
---
|
||||||
|
title: Example post
|
||||||
|
description: This is just an example post to show the format of new 2.0 posts
|
||||||
|
menu:
|
||||||
|
v2_0:
|
||||||
|
name: Example post
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
_This is just an example post._
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
{{ partial "header.html" . }}
|
||||||
|
|
||||||
|
<h1>{{ .Title }}</h1>
|
||||||
|
|
||||||
|
{{ .Content }}
|
||||||
|
|
||||||
|
{{ partial "footer.html" . }}
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
{{ partial "header.html" . }}
|
||||||
|
|
||||||
|
<h1>{{ .Title }}</h1>
|
||||||
|
|
||||||
|
{{ .Content }}
|
||||||
|
|
||||||
|
{{ partial "footer.html" . }}
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
{{ partial "header.html" . }}
|
||||||
|
|
||||||
|
<h1>{{ .Title }}</h1>
|
||||||
|
|
||||||
|
{{ .Content }}
|
||||||
|
|
||||||
|
{{ partial "footer.html" . }}
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
{{ partial "header.html" }}
|
||||||
|
|
||||||
|
<p><em>This is a placeholder for the future InfluxDB v2.0 homepage.</em></p>
|
||||||
|
<p><a href="/v2.0/">v2.0 director</a></p>
|
||||||
|
|
||||||
|
{{ partial "footer.html"}}
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||||
|
<meta name="description" content="{{ if .Description }}{{ .Description }}. {{ end }}">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
||||||
|
<title>{{ if .Title }} {{ .Title }}{{ end }} | InfluxData Documentation</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
Loading…
Reference in New Issue