From 85cdb99547dca1f2ebeba894411555567e59166c Mon Sep 17 00:00:00 2001 From: Ollie <69084614+olijeffers0n@users.noreply.github.com> Date: Fri, 9 Jun 2023 21:29:20 +0100 Subject: [PATCH 1/4] Move the config pages and owens paper-plugins page to the correct category --- config/sidebar.paper.ts | 17 +++++++++++++---- .../configuration/README.md} | 10 ++-------- .../{ => configuration}/global-configuration.md | 0 .../{ => configuration}/world-configuration.md | 0 vercel.json | 4 ++++ 5 files changed, 19 insertions(+), 12 deletions(-) rename docs/paper/admin/{how-to/configuration.md => reference/configuration/README.md} (96%) rename docs/paper/admin/reference/{ => configuration}/global-configuration.md (100%) rename docs/paper/admin/reference/{ => configuration}/world-configuration.md (100%) diff --git a/config/sidebar.paper.ts b/config/sidebar.paper.ts index a0d82f85e..35aacd409 100644 --- a/config/sidebar.paper.ts +++ b/config/sidebar.paper.ts @@ -23,7 +23,6 @@ const paper: SidebarsConfig = { "admin/getting-started/getting-started", "admin/getting-started/adding-plugins", "admin/getting-started/migration", - "admin/reference/paper-plugins", ], }, { @@ -35,7 +34,6 @@ const paper: SidebarsConfig = { }, items: [ "admin/how-to/basic-troubleshooting", - "admin/how-to/configuration", "admin/how-to/update", "admin/how-to/aikars-flags", "admin/how-to/anti-xray", @@ -49,9 +47,20 @@ const paper: SidebarsConfig = { slug: "/cat/admin/reference", }, items: [ - "admin/reference/global-configuration", - "admin/reference/world-configuration", + { + type: "category", + label: "Paper Configuration", + link: { + type: "doc", + id: "admin/reference/configuration/README", + }, + items: [ + "admin/reference/configuration/global-configuration", + "admin/reference/configuration/world-configuration", + ], + }, "admin/reference/system-properties", + "admin/reference/paper-plugins", ], }, ], diff --git a/docs/paper/admin/how-to/configuration.md b/docs/paper/admin/reference/configuration/README.md similarity index 96% rename from docs/paper/admin/how-to/configuration.md rename to docs/paper/admin/reference/configuration/README.md index 21b38f6a0..95519d0f9 100644 --- a/docs/paper/admin/how-to/configuration.md +++ b/docs/paper/admin/reference/configuration/README.md @@ -1,8 +1,8 @@ --- -slug: /configuration +slug: /reference/configuration --- -# Configuration +# Paper Configuration :::note @@ -108,9 +108,3 @@ Notice that `world_the_end/paper-world.yml` was never modified. Because of this, configuration options from `config/paper-world-defaults.yml`. Additionally, `keep-spawn-loaded` was only disabled in `resource_world/paper-world.yml` because in `config/paper-world-defaults.yml`, `keep-spawn-loaded` is set to `true`. - - - - - - diff --git a/docs/paper/admin/reference/global-configuration.md b/docs/paper/admin/reference/configuration/global-configuration.md similarity index 100% rename from docs/paper/admin/reference/global-configuration.md rename to docs/paper/admin/reference/configuration/global-configuration.md diff --git a/docs/paper/admin/reference/world-configuration.md b/docs/paper/admin/reference/configuration/world-configuration.md similarity index 100% rename from docs/paper/admin/reference/world-configuration.md rename to docs/paper/admin/reference/configuration/world-configuration.md diff --git a/vercel.json b/vercel.json index 9eddf53cb..27617d45e 100644 --- a/vercel.json +++ b/vercel.json @@ -31,6 +31,10 @@ { "source": "/paper/per-world-configuration", "destination": "/paper/configuration" + }, + { + "source": "/paper/configuration", + "destination": "/paper/reference/configuration" } ], "headers": [ From c39b81831eea2076f9376b5ccf1f89e8b116f1dc Mon Sep 17 00:00:00 2001 From: Ollie <69084614+olijeffers0n@users.noreply.github.com> Date: Fri, 9 Jun 2023 22:00:15 +0100 Subject: [PATCH 2/4] Fix some of the hyperlinks --- docs/paper/admin/how-to/anti-xray.mdx | 14 +++++++------- docs/paper/admin/how-to/basic-troubleshooting.md | 4 ++-- .../reference/configuration/world-configuration.md | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/paper/admin/how-to/anti-xray.mdx b/docs/paper/admin/how-to/anti-xray.mdx index 6baa82d31..7a5207dd2 100644 --- a/docs/paper/admin/how-to/anti-xray.mdx +++ b/docs/paper/admin/how-to/anti-xray.mdx @@ -11,13 +11,13 @@ Paper includes an obfuscation-based Anti-Xray with two modes, configurable on a :::info[Per World Configuration] If you aren't already familiar with per world configuration, please take a moment to familiarize -yourself with the [Configuration Guide](configuration.md). +yourself with the [Configuration Guide](./reference/configuration). ::: This guide is a step-by-step walk-through for configuring Anti-Xray. For reference documentation, refer to the Anti-Xray section of the -[Per-World Configuration Reference](../reference/world-configuration.md#anti-xray). +[Per-World Configuration Reference](../reference/configuration/world-configuration.md#anti-xray). Anti-Xray has two different modes. `engine-mode: 1` replaces specified blocks (`hidden-blocks`) with other "fake" blocks, `stone` (`deepslate` at y < 0), `netherrack`, or `end_stone` based on the @@ -52,7 +52,7 @@ included out of the box. generation. If the client is able to obtain the world seed, it is able to know the real location of every generated ore, completely bypassing Anti-Xray. This can be partially worked around by making it harder for the client to reverse the world seed with the -[`feature-seeds` configuration](../reference/world-configuration.md#feature-seeds), in conjunction +[`feature-seeds` configuration](../reference/configuration/world-configuration.md#feature-seeds), in conjunction with the structure seed options in `spigot.yml`. Note that this is not a complete solution, and it may still be possible for a client to obtain the server's world seed. Using a different seed for each world may also be beneficial. @@ -130,7 +130,7 @@ anticheat: Nether Configuration Copy and paste into your `paper-world.yml` within your nether world folder. See the -[Configuration Guide](configuration.md) for more information. +[Configuration Guide](./reference/configuration) for more information. {/* prettier-ignore */} ```yml title="world_nether/paper-world.yml" @@ -157,7 +157,7 @@ anticheat: End Configuration Copy and paste into your `paper-world.yml` within your end world folder. See the -[Configuration Guide](configuration.md) for more information. +[Configuration Guide](./reference/configuration) for more information. {/* prettier-ignore */} ```yml title="world_the_end/paper-world.yml" @@ -237,7 +237,7 @@ anticheat: Nether Configuration Copy and paste into your `paper-world.yml` within your nether world folder. See the -[Configuration Guide](configuration.md) for more information. +[Configuration Guide](./reference/configuration) for more information. {/* prettier-ignore */} ```yml title="world_nether/paper-world.yml" @@ -276,7 +276,7 @@ anticheat: End Configuration Copy and paste into your `paper-world.yml` within your end world folder. See the -[Configuration Guide](configuration.md) for more information. +[Configuration Guide](./reference/configuration) for more information. {/* prettier-ignore */} ```yml title="world_the_end/paper-world.yml" diff --git a/docs/paper/admin/how-to/basic-troubleshooting.md b/docs/paper/admin/how-to/basic-troubleshooting.md index d24b3ec32..cc6e50225 100644 --- a/docs/paper/admin/how-to/basic-troubleshooting.md +++ b/docs/paper/admin/how-to/basic-troubleshooting.md @@ -125,8 +125,8 @@ Many plugins provide their own documentation about how to set them up properly. Paper can also be configured in a variety of ways. Check these documents for detailed explanations about each configuration. -* [Paper Global Config](../reference/global-configuration.md) -* [Paper Per World Configuration](../reference/world-configuration.md) +* [Paper Global Config](../reference/configuration/global-configuration.md) +* [Paper Per World Configuration](../reference/configuration/world-configuration.md) ## Consult With Developer diff --git a/docs/paper/admin/reference/configuration/world-configuration.md b/docs/paper/admin/reference/configuration/world-configuration.md index 9ec153d23..60237064f 100644 --- a/docs/paper/admin/reference/configuration/world-configuration.md +++ b/docs/paper/admin/reference/configuration/world-configuration.md @@ -11,8 +11,8 @@ keywords: # Paper Per World Configuration Configuration options in `paper-world-defaults.yml` are configurable on a per-world basis. For more -information, see the [Configuration Guide](../how-to/configuration.md) For global configuration, see -the [Paper Global Configuration Reference](global-configuration.md) +information, see the [Configuration Guide](./configuration) For global configuration, see +the [Paper Global Configuration Reference](./global-configuration.md) ## anticheat @@ -21,7 +21,7 @@ the [Paper Global Configuration Reference](global-configuration.md) :::tip Recommended configuration for both `engine-mode` `1` and `2` can be found in the -[Configuring Anti-Xray](../how-to/anti-xray.mdx) guide. +[Configuring Anti-Xray](../../how-to/anti-xray.mdx) guide. ::: From a76e7234e4d88ce042537517678fa728589ed2d1 Mon Sep 17 00:00:00 2001 From: Ollie <69084614+olijeffers0n@users.noreply.github.com> Date: Fri, 9 Jun 2023 22:02:41 +0100 Subject: [PATCH 3/4] Fix more hyperlinks --- docs/paper/admin/getting-started/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/paper/admin/getting-started/getting-started.md b/docs/paper/admin/getting-started/getting-started.md index 8f3eb64ed..e7a9d9a2e 100644 --- a/docs/paper/admin/getting-started/getting-started.md +++ b/docs/paper/admin/getting-started/getting-started.md @@ -54,8 +54,8 @@ disables Vanilla's GUI, so you don't get double interfaces when using the comman For more advanced Java tuning, see [Aikar's Flags](../how-to/aikars-flags.md). -To configure your server, see the [Global Configuration](../reference/global-configuration.md) and -[Per World Configuration](../reference/world-configuration.md) pages. +To configure your server, see the [Global Configuration](../reference/configuration/global-configuration.md) and +[Per World Configuration](../reference/configuration/world-configuration.md) pages. ## Updating The Server From dab9f6d77ea8ddfcdd63033037fd88001cd4c7d8 Mon Sep 17 00:00:00 2001 From: Ollie <69084614+olijeffers0n@users.noreply.github.com> Date: Fri, 9 Jun 2023 22:20:29 +0100 Subject: [PATCH 4/4] Remove obsolete note --- docs/paper/admin/reference/configuration/README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/paper/admin/reference/configuration/README.md b/docs/paper/admin/reference/configuration/README.md index 95519d0f9..bc3bcf804 100644 --- a/docs/paper/admin/reference/configuration/README.md +++ b/docs/paper/admin/reference/configuration/README.md @@ -4,14 +4,6 @@ slug: /reference/configuration # Paper Configuration -:::note - -This guide currently only covers per-world configuration in `paper-world-defaults.yml`. Information -about general configuration will be added in the future. In the meantime, please refer to the -information in the [1.19 announcement forum post](https://forums.papermc.io/threads/paper-1-19.344). - -::: - ## Per World Configuration