Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 2.38 KB

README.md

File metadata and controls

67 lines (50 loc) · 2.38 KB
Raw

InfluxData Documentation

This repository powers docs.influxdata.com, which includes documentation for the following InfluxData projects:

Contributing

InfluxData's documentation is open source. We strongly encourage (and value!) any contributions from the community.

Contributions include:

  • General content improvement: typo fixes and sentence clarifications
  • New content: documentation for new features and guides for common use cases

Please feel free to open an issue or a pull request. See the Contributing Guide for more information.

Requirements

Hugo

We use Hugo, an open source static site generator, to build our documentation. Check out the Hugo website for installation instructions.

Style Requirements

Markdown

All of our documentation is written in Markdown. If you're not a Markdown expert but you have content to contribute, feel free to submit a PR and we'll help you out with the formatting.

Semantic Linefeeds

We use semantic linefeeds. Separating each sentence with a new line makes it easy to parse diffs with the human eye.

Diff without semantic linefeeds:

-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:

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.

Writing Style

In general, we try to keep our writing style approachable and easy to understand.