Restructure install documentation after developer documentation split.
MODIFY
.github/ISSUE_TEMPLATE/bug.yml
.github/ISSUE_TEMPLATE/bug.yml
@@ -5,15 +5,12 @@ body:
- type: markdown
attributes:
value: |
- Before you continue reporting the bug, be sure that you use the latest released version:
+ Before you continue reporting the bug, be sure that you are using supported installation method, see
- - https://github.com/Taxel/PlexTraktSync/tags
-
- Using branch, e.g "main" is not supported, you must use released version when reporting a bug.
+ - https://github.com/Taxel/PlexTraktSync#installation
- Be sure to use required pip packages matching the release, see
-
- - https://github.com/Taxel/PlexTraktSync#installing
+ You can find latest version from here:
+ - https://github.com/Taxel/PlexTraktSync/tags
- type: textarea
id: description

MODIFY
CONTRIBUTING.md
CONTRIBUTING.md
@@ -41,11 +41,13 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
[issues]: https://github.com/Taxel/PlexTraktSync/issues
[opening a new issue]: https://github.com/Taxel/PlexTraktSync/issues/new
-## GitHub Tags
+## Checking out code
-Releases are made through tags. If you wish to access a download a specific release for testing this can be done in one of two ways:
+If you checkout a specific version, this can be done in one of two ways:
+- [GitHub download](#github-download)
+- [Git clone](#git-clone)
-Note: Development should be done against the main branch and not a specific tag.
+Note: Development should be done against the `main` branch and not a specific tag.
### GitHub download
@@ -55,7 +57,7 @@ Note: Development should be done against the main branch and not a specific tag.
Proceed to [Install dependencies](#install-dependencies)
-### GitHub clone
+### Git clone
- Find the latest release from https://github.com/Taxel/PlexTraktSync/tags
- Checkout the release with Git:
@@ -63,9 +65,7 @@ Proceed to [Install dependencies](#install-dependencies)
git clone -b 0.15.0 --depth=1 https://github.com/Taxel/PlexTraktSync
```
-NOTE: Use released versions, when making bug reports.
-
-To upgrade a GitHub clone, find the latest tag and checkout:
+To switch to a different version, find the latest tag and checkout:
```
git fetch --tags
@@ -76,7 +76,7 @@ Proceed to [Install dependencies](#install-dependencies)
### Install dependencies
-This applies to [GitHub download](#github-download) and [GitHub clone](#github-clone).
+This applies to [GitHub download](#github-download) and [Git clone](#git-clone).
In the `PlexTraktSync` directory, install the required Python packages:
```

MODIFY
README.md
README.md
@@ -27,7 +27,6 @@ Note: The PyTrakt API keys are not stored securely, so if you do not want to hav
- [Watch](#watch)
- [Systemd setup](#systemd-setup)
-
**To contribute, please find issues with the [`help-wanted`](https://github.com/Taxel/PlexTraktSync/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) label, thank you.**
[python-versions-badge]: https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue
@@ -87,7 +86,6 @@ or check output of [info command](#info-command).
[appdirs]: https://pypi.org/project/appdirs
[install-pipx]: https://github.com/pypa/pipx#install-pipx
-
### Docker Compose
You can setup docker compose file like this:
@@ -134,7 +132,8 @@ Create a Unraid container of PlexTraktSync:
### GitHub
-If you wish to install from a specific GitHub tagged release, read the guidance in [CONTRIBUTING.md](CONTRIBUTING.md)
+Installing from GitHub is considered developer mode and it's documented in
+[CONTRIBUTING.md](CONTRIBUTING.md#checking-out-code).
## Setup

Restructure install documentation after developer documentation split. #688