commit 483c32c6bb315f27c8e4a314654f73c385175633 Author: Scott Anderson Date: Thu Dec 13 11:47:02 2018 -0700 first commit to the influxdb 2.0 docs! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..3a727a9df --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 000000000..8b918dca8 --- /dev/null +++ b/README.md @@ -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 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. diff --git a/config.toml b/config.toml new file mode 100644 index 000000000..965f80dc0 --- /dev/null +++ b/config.toml @@ -0,0 +1,3 @@ +baseURL = "http://docs.influxdata.com/" +languageCode = "en-us" +title = "InfluxDB Documentation" diff --git a/content/v2.0/_index.md b/content/v2.0/_index.md new file mode 100644 index 000000000..b02a1b6d1 --- /dev/null +++ b/content/v2.0/_index.md @@ -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._ diff --git a/content/v2.0/example.md b/content/v2.0/example.md new file mode 100644 index 000000000..53df16e85 --- /dev/null +++ b/content/v2.0/example.md @@ -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._ diff --git a/layouts/_default/list.html b/layouts/_default/list.html new file mode 100644 index 000000000..a903ad606 --- /dev/null +++ b/layouts/_default/list.html @@ -0,0 +1,7 @@ +{{ partial "header.html" . }} + +

+ +{{ .Content }} + +{{ partial "footer.html" . }} diff --git a/layouts/_default/section.html b/layouts/_default/section.html new file mode 100644 index 000000000..a903ad606 --- /dev/null +++ b/layouts/_default/section.html @@ -0,0 +1,7 @@ +{{ partial "header.html" . }} + +

+ +{{ .Content }} + +{{ partial "footer.html" . }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html new file mode 100644 index 000000000..a903ad606 --- /dev/null +++ b/layouts/_default/single.html @@ -0,0 +1,7 @@ +{{ partial "header.html" . }} + +

+ +{{ .Content }} + +{{ partial "footer.html" . }} diff --git a/layouts/index.html b/layouts/index.html new file mode 100644 index 000000000..205495090 --- /dev/null +++ b/layouts/index.html @@ -0,0 +1,6 @@ +{{ partial "header.html" }} + +

This is a placeholder for the future InfluxDB v2.0 homepage.

v2.0 director

+ +{{ partial "footer.html"}} diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html new file mode 100644 index 000000000..b605728ee --- /dev/null +++ b/layouts/partials/footer.html @@ -0,0 +1,2 @@ + + diff --git a/layouts/partials/header.html b/layouts/partials/header.html new file mode 100644 index 000000000..c4b657f8c --- /dev/null +++ b/layouts/partials/header.html @@ -0,0 +1,10 @@ + + + + + + + + {{ if .Title }} {{ .Title }}{{ end }} | InfluxData Documentation + +