Skip to content

Commit

Permalink
fixup! Upgrade to Docusaurus v3
Browse files Browse the repository at this point in the history
  • Loading branch information
rcdailey committed Apr 21, 2024
1 parent 76ca67a commit 22db251
Show file tree
Hide file tree
Showing 21 changed files with 254 additions and 481 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ please use the general guidelines below to know which admonition types to use in
Advice or tips that help the user. Topics might not be directly related to surrounding subject
matter.

- 🟡 **CAUTION** (`:::caution`)<br/>
- 🟡 **CAUTION** (`:::warning`)<br/>
Warning messages about an action or piece of information. Things the user should heed, but it
won't be the end of the world if they don't.

Expand Down
4 changes: 2 additions & 2 deletions docs/_configs-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The pre-built configuration files can be deployed in two ways:

## Customization

:::caution
:::warning

The pre-built configuration files are designed as a simple mechanism to deploy one or more of the
TRaSH Guides profiles, in exactly the same configuration as they appear on the guides pages.
Expand All @@ -39,7 +39,7 @@ building your own custom configuration file.

:::

:::caution
:::warning

At this time, include templates can only be used with quality profiles that have the **same name**
as shown in the equivalent guide profile page. The profile name is hard-coded into the
Expand Down
10 changes: 6 additions & 4 deletions docs/behavior/quality-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,16 @@ When `quality_sort` is set to `top` (which is also the *default* if you do not s
property), qualities and groups you *explicitly specify* in your YAML are sorted to the top of the
list. *Unspecified* qualities appear at the bottom.

:::caution Impact on Cutoff
:::warning Impact on Cutoff

If qualities are removed instead of disabled, this can cause unwanted downgrades of movie files.

:::

#### Example

<details><summary>Click to Expand Example</summary>
<details>
<summary>Click to Expand Example</summary>

```yml
quality_sort: top
Expand All @@ -77,15 +78,16 @@ When you sync this quality profile, it will look like this when you view it in t
When `quality_sort` is set to `bottom`, qualities and groups you *explicitly specify* in your YAML
are sorted to the bottom of the list. *Unspecified* qualities appear at the top.

:::caution Impact on Cutoff
:::warning Impact on Cutoff

If qualities are removed instead of disabled, this can result in upgrades never happening.

:::

#### Example

<details><summary>Click to Expand Example</summary>
<details>
<summary>Click to Expand Example</summary>

Using the same example YAML from the previous section:

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/config/config-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ recyclarr config create -t uhd-bluray-web -t remux-web-1080p

### `-f|--force`

:::caution
:::warning

This is a destructive operation! Use carefully.

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/delete/delete-custom-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ If this option is used, any explicit CFs provided to the `[cf_names]` argument a

If specified, performs the delete operation without a confirmation prompt.

:::caution
:::warning

Know what you are doing before you use this option!

Expand Down
12 changes: 5 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 4
title: Getting Started
---

:::caution
:::warning

Please make sure you've reviewed the various [installation methods](installation/index.md) before
getting started here.
Expand All @@ -18,9 +18,8 @@ which varies depending on your chosen platform.
Choose the section below representing your chosen installation method and run those steps if you
want to get started with a minimal configuration file.

<details><summary>
Docker
</summary>
<details>
<summary>Docker</summary>

[Installation Instructions](installation/docker.md)

Expand All @@ -42,9 +41,8 @@ the previous step.

</details>

<details><summary>
Manual Installation
</summary>
<details>
<summary>Manual Installation</summary>

[Installation Instructions](installation/manual-install.md)

Expand Down
14 changes: 6 additions & 8 deletions docs/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ because the `docker-compose.yml` file is a fantastic way to keep configuration d
Thus, for the remainder of this page, all instruction and advice will be based on the example YAML
below. I highly recommend you set up your own `docker-compose.yml` this way.

:::caution
:::warning

The below example should not be used verbatim. It's meant for example purposes only. Copy & paste it
but make the appropriate and necessary changes to it for your specific use case.
Expand Down Expand Up @@ -140,7 +140,7 @@ where:
Using the table at the start of the Tags section, an example might be `2.1.3-dev.50` where `2.1.3`
is the *current* next version after `2.1.2`.

:::caution
:::warning

Prerelease tags do not live indefinitely. An unspecified *retention period* is applied to them,
meaning that these tags are **permanently deleted from upstream docker registries** after that
Expand Down Expand Up @@ -207,9 +207,8 @@ one or the other depending on the following:

See the respective sections below for whichever mode you wish to use.

<details><summary>
Using Docker Run
</summary>
<details>
<summary>Using Docker Run</summary>

When using `docker run` to invoke Recyclarr in manual mode, the container starts up, runs a
user-specified operation, and then exits. This is semantically identical to running Recyclarr
Expand Down Expand Up @@ -248,9 +247,8 @@ containers will start to grow the more often you run it manually).

</details>

<details><summary>
Using Docker Exec
</summary>
<details>
<summary>Using Docker Exec</summary>

Using `docker exec` for manual mode is similar to the previous section, except that it uses an
already-running instance of the container to perform actions.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/tips/git-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Skip this section if you're using Chocolatey or Winget methods.

:::

:::caution
:::warning

Before proceeding, **close any open terminal windows** such as Powershell and CMD/Command Prompt.
The Git installer will modify your `PATH` environment variable. Terminals will not reload updates to
Expand Down
2 changes: 1 addition & 1 deletion docs/sqp-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ deploying one of more of the TRaSH Guides profiles:
[radarr-sqp-4-trash]: https://trash-guides.info/SQP/4/
[radarr-sqp-5-trash]: https://trash-guides.info/SQP/5/

:::caution
:::warning

- The information provided on this page is for private use only and is not to be made public. :bangbang:
- Users who have been provided with the link to this page **must** keep it private. :bangbang:
Expand Down
12 changes: 8 additions & 4 deletions docs/troubleshooting/errors-warnings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ This section contains a list of warnings you might see in your console output /
usually caused by configuration issues or something else within the user's control to fix. Below are
examples of messages you may see with some guidance on how to address them.

<details><summary>
<details>
<summary>
Custom format with trash ID e23edd2482476e595fb990b12e7c609c is duplicated 1 times in quality
profile SD with the following scores: [500]
</summary>
Expand Down Expand Up @@ -54,7 +55,8 @@ custom_formats:

</details>

<details><summary>
<details>
<summary>
No configuration YAML files found
</summary>

Expand All @@ -75,7 +77,8 @@ and their structure.

</details>

<details><summary>
<details>
<summary>
Incompatible value assigned/used at line 7: Invalid cast from 'System.String' to
'Recyclarr.TrashLib.Config.Services.QualityDefinitionConfig'
</summary>
Expand Down Expand Up @@ -116,7 +119,8 @@ The troubleshooting steps documented here are for the non-docker version of Recy
directly on a host machine). The [Docker](installation/docker.md) page has troubleshooting steps as
well.

<details><summary>
<details>
<summary>
Failed to create CoreCLR, HRESULT: 0x8007000E
</summary>

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/reporting-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: help
title: Getting Help
---

:::caution
:::warning

Recyclarr may stop working at any time due to guide updates and changes in either Radarr or Sonarr.
It is a priority to fix them in a timely manner. [Reporting][issues] such issues ASAP would be
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guide/v5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The reason for this change is due to quirky logic with specifying this flag mult
same profile. Now that the flag is attached to a Quality Profile config, it will be more clear how
the value will be set.

:::caution
:::warning

At the moment, `quality_profiles` does **not create quality profiles for you!** You are still
responsible for ensuring that the quality profile (in the above example, `SD`) exists.
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guide/v7.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ in the past. Deprecations are always mentioned in release notes for minor versio

### Path Change on MacOS {#osx-path-change}

:::caution
:::warning

If you are not running Recyclarr on MacOS, **no action is needed!**

Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/config-reference/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This property can be implicitly set via secrets if you follow a naming conventio

:::

:::caution
:::warning

The `base_url` value is used to uniquely identify an instance of a service (such as Radarr). This
means that if you relocate your instances to a new URL (change of port, hostname, or path),
Expand Down
6 changes: 3 additions & 3 deletions docs/yaml/config-reference/quality-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ used with this property. Visit the [relevant CLI reference page][cliscoresets] f

## `min_format_score` {#min-format-score}

:::caution
:::warning

This property is **not supported** with Sonarr v3!

Expand Down Expand Up @@ -161,7 +161,7 @@ list, this property is optional and will leave your manually set cutoff alone.

## `until_score` {#until-score}

:::caution
:::warning

This property is **not supported** with Sonarr v3!

Expand Down Expand Up @@ -215,7 +215,7 @@ If this is omitted or set to `true`, this quality will be allowed. This is the e
checking the box next to the quality in the Radarr or Sonarr UI. If set to `false`, this quality
will be disallowed (unchecks the box).

:::caution
:::warning

There are two distinct methods of disabling (disallowing) a quality: Either set this property to
`false` or delete the quality from the list entirely. **Make sure you understand the behavioral
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/config-reference/release-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ service_type:
**Optional.** *Default: No release profiles are synced*
:::caution
:::warning
Release Profiles may not be used in Sonarr version 4 or greater!
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Where:
- `my_default_value` is an **optional** default value to use if the specified environment variable
is either not defined, a blank string, or contains only whitespace characters.

:::caution
:::warning

If an environment variable cannot be found or does not have a value as defined above, *and* no
default value is provided, an exception is thrown and configuration loading will fail for that
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/secrets-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ radarr:
api_key: !secret radarr4k_another_apikey
```

:::caution
:::warning

Recyclarr will fail to load your configuration if there are references to keys that don't exist in
the `secrets.yml`.
Expand Down
2 changes: 1 addition & 1 deletion docs/yaml/settings-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Example of file location (using docker path):
If this file does not exist, Recyclarr will create it for you. Starting out, this file will be empty
and default behavior will be used.

:::caution
:::warning

There is absolutely no need to touch this file unless you have a specific reason to. It is
recommended that you only add the specific properties for the customizations you need and leave the
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
},
"dependencies": {
"@algolia/client-search": "^4.19.1",
"@docusaurus/core": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@docusaurus/core": "^3.2.1",
"@docusaurus/preset-classic": "^3.2.1",
"@iconify/react": "^4.1.1",
"@mdx-js/react": "^3",
"@types/react": "^18",
"clsx": "^2.0.0",
"docusaurus-theme-github-codeblock": "^1.1.4",
"docusaurus-theme-github-codeblock": "^2.0.2",
"prism-react-renderer": "^1.3.5",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand All @@ -30,7 +30,7 @@
"typescript": "^4.9.4"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.1.1"
"@docusaurus/module-type-aliases": "^3.2.1"
},
"browserslist": {
"production": [
Expand Down
Loading

0 comments on commit 22db251

Please sign in to comment.