From 5707566cf7edf21c5aac7e55d2f5f091811853df Mon Sep 17 00:00:00 2001 From: Danshil Kokil Mungur Date: Wed, 19 Jan 2022 21:02:58 +0400 Subject: [PATCH] docs: add contribution, support and install clarifications (#2395) [skip ci] * docs(contrib): clarify when to squash commits * docs(support): ask for more details when requesting support * docs(install): specify more container details * docs(contrib): suggested changes --- CONTRIBUTING.md | 4 ++-- docs/getting-started/installation.md | 2 +- docs/support/need-help.md | 5 +++++ 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e16f9eab..e54e45d67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,9 +68,9 @@ All help is welcome and greatly appreciated! If you would like to contribute to - If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/sct/overseerr/issues) to avoid multiple people working on the same thing. - All commits **must** follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) - - It is okay to squash your pull request down into a single commit that fits this standard. - Pull requests with commits not following this standard will **not** be merged. -- Please make meaningful commits, or squash them. +- Please make meaningful commits, or squash them prior to opening a pull request. + - Do not squash commits once people have begun reviewing your changes. - Always rebase your commit to the latest `develop` branch. Do **not** merge `develop` into your branch. - It is your responsibility to keep your branch up-to-date. Your work will **not** be merged unless it is rebased off the latest `develop` branch. - You can create a "draft" pull request early to get feedback on your work. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index f3dce15f4..98e26f59f 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -143,7 +143,7 @@ or the Docker Desktop app: Then, create and start the Overseerr container: ```bash -docker run -d -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr +docker run -d --name overseerr -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr:latest ``` If using a named volume like above, you can safely ignore the warning about the `/app/config` folder being incorrectly mounted on the setup page. diff --git a/docs/support/need-help.md b/docs/support/need-help.md index 8e2cc8567..2d4782529 100644 --- a/docs/support/need-help.md +++ b/docs/support/need-help.md @@ -19,6 +19,11 @@ Please try to include as much information as possible. A vague statement like "i Try to answer the following questions: +- What version of Overseerr are you running? (You can find this in Settings → About → Version.) +- How did you install Overseerr? Are you using the official Docker or snap images, or images published by a third-party? +- How are you accessing Overseerr? + - Are you accessing Overseerr through your reverse proxy or via a local IP address? + - What browser are you using? What browser extensions are enabled? - What were you trying to do, and how did you attempt it? - What command did you enter? - What did you click on?