diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6356af251..cdff6cc62 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,9 +14,9 @@ +If you're adding a new Custom Format, make sure you follow the [Radarr/Sonarr Custom Format (JSON) Guidelines](https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md). --> ## Requirements -- [ ] These changes meet the standards for [contributing](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md). +- [ ] These changes meet the standards for [contributing](https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md). - [ ] I have read the [code of conduct](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CODE_OF_CONDUCT.md). diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 84% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index ba8b3ff78..7cf30add6 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,4 +144,40 @@ When updating or adding a new CF the test case url (`trash_regex`) needs to be p ## Recommendations -- use [VSCode](https://code.visualstudio.com/) for editing with the following extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) +Use [VSCode](https://code.visualstudio.com/) for editing. VS Code should recommend extensions to you +based on the `.vscode/extensions.json` file; you should install all of them. + +## Preview Docs Locally + +### Prerequisites + +These prerequisites are taken from the [mkdocs installation instructions][mkdocinstall]. + +- Install a recent version of [Python 3](https://www.python.org/). +- `pip` is also required, but should come with Python. Run `pip --version` to check if its available + and working. See the [installation instructions](https://pip.pypa.io/en/stable/installation/). + +[mkdocinstall]: https://www.mkdocs.org/user-guide/installation/ + +### Mkdocs Installation + +First, install mkdocs: + +```bash +pip install mkdocs +``` + +Then, install dependent modules using the command below. This command should be run in the root +directory of the repository (i.e. where the `requirements.txt` file is). If the `pip` command does +not work, refer to the mkdocs installation page linked in the Prerequisite section above. + +```bash +pip install -r docs/requirements.txt +``` + +Once everything is installed, run the command below to start a local dev server to preview your +changes to mkdocs: + +```bash +mkdocs serve +``` diff --git a/docs/Bazarr/scripts/index.md b/docs/Bazarr/scripts/index.md index 659df7414..2362d8fce 100644 --- a/docs/Bazarr/scripts/index.md +++ b/docs/Bazarr/scripts/index.md @@ -3,7 +3,7 @@ !!! note "" Here you will find a collection of Scripts you can use with Bazarr. - Most of them are provided by other users, if you got a script you want to share don't hesitate to create a [PR](https://github.com/TRaSH-Guides/Guides/blob/master/.github/CONTRIBUTING.md) for it + Most of them are provided by other users, if you got a script you want to share don't hesitate to create a [PR](https://github.com/TRaSH-Guides/Guides/blob/master/CONTRIBUTING.md) for it ## 2 to 3 language code