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

Various small docs improvements #285

Merged
merged 1 commit into from
Dec 2, 2019

Conversation

gundalow
Copy link
Contributor

@gundalow gundalow commented Dec 1, 2019

Firstly thanks for this great bit of Software, I just got it setup over the weekend (in Digital Ocean). I'm no programmer, though I hope these docs improvements are useful. If I've done too much let me know and I can trim it down a bit.

  1. Use consistent terms for Docker installs
  2. State requirements for installs
  3. Don't repeat basic Docker setup (should help avoid pages getting out of sync in the future
  4. Few minor formatting/spelling improvements
  5. Tweak formatting of the upgrade guide to hopefully make it clearer

@adriankumpf
Copy link
Collaborator

These improvements are really useful. I wasn't sure at first if the basic Docker setup should be removed from the readme, but it definitely makes sense to have the instructions in one place. Thank you!

@adriankumpf adriankumpf merged commit d8982a3 into teslamate-org:master Dec 2, 2019
@gundalow gundalow deleted the tweak_docs branch December 2, 2019 19:08
@gundalow
Copy link
Contributor Author

gundalow commented Dec 2, 2019

@adriankumpf Thank you for the prompt review and merge.
I was also in two minds about the install doc, glad what I've done works for you.

Anything else I can help with? I'm a maintainer for some major projects on GitHub, so I know my way around a fair bit of stuff.

@adriankumpf
Copy link
Collaborator

Anything else I can help with? I'm a maintainer for some major projects on GitHub, so I know my way around a fair bit of stuff.

Wow! Yeah, there are a couple of things :-) I would be very happy if you could proofread the rest of the documentation or the web interface (labels, tooltips etc) . Some parts probably don't make much sense or sound strange to a native speaker. Answering questions and generally helping with GitHub issues would also be awesome. In addition, of course, contributions of any kind are very welcome – e.g. if you're familiar with Grafana feel free to improve the dashboards or add new ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants