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.
Reporting a Vulnerability
InfluxData takes security and our users' trust very seriously. If you believe you have found a security issue in any of our open source projects, please responsibly disclose it by contacting security@influxdata.com. More details about security vulnerability reporting, including our GPG key, can be found at https://www.influxdata.com/how-to-report-security-vulnerabilities/.
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 is taking off. This data is time series. You need a database that specializes in time series. You should check out InfluxDB.
+Data is taking off. This data is time series. You need a database that specializes in time series. You need InfluxDB.Diff with semantic linefeeds:
Data is taking off.
This data is 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.