✏️ Split add-on documentation

Author: frenck

README.md

@@ -37,170 +37,7 @@ gives you a nice InfluxDB admin interface for managing your users, databases,
 data retention settings, and lets you peek inside the database using the
 Data Explorer.
 
-## Installation
-
-The installation of this add-on is pretty straightforward and not different in
-comparison to installing any other Home Assistant add-on.
-
-1. Search for the "InfluxDB" add-on in the Supervisor add-on store and install it.
-1. Start the "InfluxDB" add-on.
-1. Check the logs of the "InfluxDB" to see if everything went well.
-1. Click the "OPEN WEB UI" button!
-
-## Configuration
-
-**Note**: _Remember to restart the add-on when the configuration is changed._
-
-Example add-on configuration:
-
-```yaml
-log_level: info
-auth: true
-reporting: true
-ssl: true
-certfile: fullchain.pem
-keyfile: privkey.pem
-envvars:
-  - name: INFLUXDB_HTTP_LOG_ENABLED
-    value: 'true'
-```
-
-**Note**: _This is just an example, don't copy and paste it! Create your own!_
-
-### Option: `log_level`
-
-The `log_level` option controls the level of log output by the addon and can
-be changed to be more or less verbose, which might be useful when you are
-dealing with an unknown issue. Possible values are:
-
-- `trace`: Show every detail, like all called internal functions.
-- `debug`: Shows detailed debug information.
-- `info`: Normal (usually) interesting events.
-- `warning`: Exceptional occurrences that are not errors.
-- `error`:  Runtime errors that do not require immediate action.
-- `fatal`: Something went terribly wrong. Add-on becomes unusable.
-
-Please note that each level automatically includes log messages from a
-more severe level, e.g., `debug` also shows `info` messages. By default,
-the `log_level` is set to `info`, which is the recommended setting unless
-you are troubleshooting.
-
-### Option: `auth`
-
-Enable or disable InfluxDB user authentication.
-
-**Note**: _Turning this off is NOT recommended!_
-
-### Option: `reporting`
-
-This option allows you to disable the reporting of usage data to InfluxData.
-
-**Note**: _No data from user databases is ever transmitted!_
-
-### Option: `ssl`
-
-Enables/Disables SSL (HTTPS) on the web interface.
-Set it `true` to enable it, `false` otherwise.
-
-**Note**: _This does NOT activate SSL for InfluxDB, just the web interface_
-
-### Option: `certfile`
-
-The certificate file to use for SSL.
-
-**Note**: _The file MUST be stored in `/ssl/`, which is the default_
-
-### Option: `keyfile`
-
-The private key file to use for SSL.
-
-**Note**: _The file MUST be stored in `/ssl/`, which is the default_
-
-### Option: `envvars`
-
-This allows the setting of Environment Variables to control InfluxDB
-configuration as documented at:
-
- <https://docs.influxdata.com/influxdb/v1.7/administration/config/#configuration-settings>
-
-**Note**: _Changing these options can possibly cause issues with you instance.
-USE AT YOUR OWN RISK!_
-
-These are case sensitive.
-
-#### Sub-option: `name`
-
-The name of the environment variable to set which must start with `INFLUXDB_`
-
-#### Sub-option: `value`
-
-The value of the environment variable to set, set the Influx documentation for
-full details.
-
-### Option: `leave_front_door_open`
-
-Adding this option to the add-on configuration allows you to disable
-authentication on the Web Terminal by setting it to `true` and leaving the
-username and password empty.
-
-**Note**: _We STRONGLY suggest, not to use this, even if this add-on is
-only exposed to your internal network. USE AT YOUR OWN RISK!_
-
-## Integrating into Home Assistant
-
-The `influxdb` integration of Home Assistant makes it possible to transfer all
-state changes to an InfluxDB database.
-
-You need to do the following steps in order to get this working:
-
-- Click on "OPEN WEB UI" to open the admin web-interface provided by this add-on.
-- On the left menu click on the "InfluxDB Admin".
-- Create a database for storing Home Assistant's data in, e.g., `homeassistant`.
-- Goto the users tab and create a user for Home Assistant,
-  e.g., `homeassistant`.
-
-Now we've got this in place, add the following snippet to your Home Assistant
-`configuration.yaml` file.
-
-```yaml
-influxdb:
-  host: a0d7b954-influxdb
-  port: 8086
-  database: homeassistant
-  username: homeassistant
-  password: <yourpassword>
-  max_retries: 3
-  default_measurement: state
-```
-
-Restart Home Assistant.
-
-You should now see the data flowing into InfluxDB by visiting the web-interface
-and using the Data Explorer.
-
-Full details of the Home Assistant integration can be found here:
-
-<https://www.home-assistant.io/components/influxdb/>
-
-## Known issues and limitations
-
-- While the Chronograph interface supports SSL, currently, the add-on does
-  not support having SSL on InfluxDB. This limitation is caused by
-  Chronograf and we are still looking into a proper solution for this.
-
-## Changelog & Releases
-
-This repository keeps a change log using [GitHub's releases][releases]
-functionality. The format of the log is based on
-[Keep a Changelog][keepchangelog].
-
-Releases are based on [Semantic Versioning][semver], and use the format
-of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
-based on the following:
-
-- ``MAJOR``: Incompatible or major changes.
-- ``MINOR``: Backwards-compatible new features and enhancements.
-- ``PATCH``: Backwards-compatible bugfixes and package updates.
+[:books: Read the full add-on documentation][docs]
 
 ## Support
 
@@ -275,17 +112,16 @@ SOFTWARE.
 [discord-ha]: https://discord.gg/c5DvZ4e
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
+[docs]: https://github.com/hassio-addons/addon-influxdb/blob/master/influxdb/DOCS.md
 [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
 [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-influxdb/54491?u=frenck
 [frenck]: https://github.com/frenck
 [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
 [github-sponsors]: https://github.com/sponsors/frenck
 [gitlabci-shield]: https://gitlab.com/hassio-addons/addon-influxdb/badges/master/pipeline.svg
 [gitlabci]: https://gitlab.com/hassio-addons/addon-influxdb/pipelines
-[home-assistant]: https://home-assistant.io
 [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
 [issue]: https://github.com/hassio-addons/addon-influxdb/issues
-[keepchangelog]: http://keepachangelog.com/en/1.0.0/
 [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-influxdb.svg
 [maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
 [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
@@ -295,5 +131,3 @@ SOFTWARE.
 [releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-influxdb.svg
 [releases]: https://github.com/hassio-addons/addon-influxdb/releases
 [repository]: https://github.com/hassio-addons/repository
-[semver]: http://semver.org/spec/v2.0.0.htm
-[webtools]: https://github.com/ukdtom/WebTools.bundle/wiki

influxdb/.README.j2

@@ -22,8 +22,6 @@ gives you a nice InfluxDB admin interface for managing your users, databases,
 data retention settings, and lets you peek inside the database using the
 Data Explorer.
 
-[Click here for the full documentation][docs]
-
 ![Chronograf in the Home Assistant Frontend][screenshot]
 
 {% if channel == "edge" %}
@@ -67,7 +65,6 @@ If you are more interested in stable releases of our add-ons:
 {% endif %}
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
-[docs]: {{ repo }}/blob/{{ version }}/README.md
 [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
 [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-influxdb/54491?u=frenck
 [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png