-
Notifications
You must be signed in to change notification settings - Fork 768
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,4 @@ | ||
# TeslaMate Documentation | ||
## Documentation | ||
|
||
## 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) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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/