Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Direct people to new RTD site #314

Merged
merged 2 commits into from
Dec 22, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TeslaMate

[![](https://readthedocs.org/projects/teslamate/badge/?version=master))](https://teslamate.readthedocs.io/)
[![](https://travis-ci.org/adriankumpf/teslamate.svg?branch=master)](https://travis-ci.org/adriankumpf/teslamate)
[![](https://coveralls.io/repos/github/adriankumpf/teslamate/badge.svg?branch=master)](https://coveralls.io/github/adriankumpf/teslamate?branch=master)
[![](https://images.microbadger.com/badges/version/teslamate/teslamate.svg)](https://hub.docker.com/r/teslamate/teslamate)
Expand All @@ -14,6 +15,10 @@ A powerful, self-hosted data logger for your Tesla.
- Visualization and data analysis with **Grafana**
- Vehicle data is published to a local **MQTT** Broker

## Documentation

The full TeslaMate documentation is available on [Read The Docs](https://teslamate.readthedocs.io/).

## Features

**Dashboards**
Expand Down Expand Up @@ -48,25 +53,7 @@ A powerful, self-hosted data logger for your Tesla.

## Quick Start

See [Docker (local install)](docs/installation/docker.md)

## Documentation

The TeslaMate documentation is available [here](docs/README.md).

- [Installation](docs/README.md#installation)
- [Docker](docs/installation/docker.md) (simplified, recommended)
- [Docker (advanced)](docs/installation/docker_advanced.md) (Reverse Proxy, Let's Encrypt Certificate, HTTP Basic Auth)
- [Debian/Ubuntu](docs/installation/debian.md) (without Docker)
- [Upgrading to a new version](docs/upgrading.md)
- [Configuration](docs/README.md#configuration)
- [Environment Variables](docs/configuration/environment_variables.md)
- [Sleep Mode Configuration](docs/configuration/sleep.md)
- [Integrations](docs/README.md#integrations)
- [HomeAssistant](docs/integrations/home_assistant.md)
- [MQTT](docs/integrations/mqtt.md)
- [Frequently Asked Questions](docs/faq.md)
- [Development](docs/development.md)
The Full TeslaMate documentation is available on [Read The Docs](https://teslamate.readthedocs.io/).

## Donations

Expand Down
35 changes: 2 additions & 33 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,4 @@
# TeslaMate Documentation
## Documentation
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI it's README.rst (rather than this file), that's uses as the index page for https://teslamate.readthedocs.io/en/latest/


## Installation
The TeslaMate documentation is available on [Read The Docs](https://teslamate.readthedocs.io/).

- [Docker](installation/docker.md) (simplified, recommended)
- [Docker (advanced)](installation/docker_advanced.md) (Reverse Proxy, Let's Encrypt Certificate, HTTP Basic Auth)
- [Debian/Ubuntu](installation/debian.md) (without Docker)
- [Kubernetes](https://hub.helm.sh/charts/billimek/teslamate) (opinionated helm chart installed with a standalone postgresql database)

## Upgrading to a new version

- [Docker Setup](upgrading.md#docker)

## Configuration

- [Environment Variables](configuration/environment_variables.md) – Documents the available runtime configuration parameters.
- [Sleep Mode Configuration](configuration/sleep.md) – Documents the sleep behaviour for Tesla vehicles and the related TeslaMate configuration
- [Shortcuts Setup](configuration/guides/shortcuts.md)
- [Tasker Setup](configuration/guides/tasker.md)
- [MacroDroid Setup](configuration/guides/macro_droid.md)

## Integrations

- [HomeAssistant](integrations/home_assistant.md)
- [MQTT](integrations/mqtt.md)

## [Frequently Asked Questions](faq.md)

- [Why are no consumption values displayed in Grafana?](faq.md#why-are-no-consumption-values-displayed-in-grafana)
- [What is the geo-fence feature for?](faq.md#what-is-the-geo-fence-feature-for)

## [Development](development.md)

- [Requirements](development.md#requirements)
- [Testing](development.md#testing)