From a428133e4718c3a1fe363ddbc2fd5de2f863cf6b Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sun, 28 May 2023 13:18:32 -0500 Subject: [PATCH] docs: collapse deprecated sections (#2151) --- README.md | 10 ++++++---- .../index.md => autopause-autostop/autopause.md} | 0 .../misc/{autopause => autopause-autostop}/autostop.md | 0 BUILDING.md => docs/misc/contributing/building.md | 0 .../misc/contributing/development.md | 6 +++--- 5 files changed, 9 insertions(+), 7 deletions(-) rename docs/misc/{autopause/index.md => autopause-autostop/autopause.md} (100%) rename docs/misc/{autopause => autopause-autostop}/autostop.md (100%) rename BUILDING.md => docs/misc/contributing/building.md (100%) rename DEVELOPMENT.md => docs/misc/contributing/development.md (88%) diff --git a/README.md b/README.md index 9741f2cb..1a14d3a5 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,8 @@ [![Build and Publish](https://github.com/itzg/docker-minecraft-server/workflows/Build%20and%20Publish/badge.svg)](https://github.com/itzg/docker-minecraft-server/actions) [![](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-orange.svg)](https://www.buymeacoffee.com/itzg) ---- +## [View the full documentation](https://docker-minecraft-server.readthedocs.io/) -## [View the documentation](https://itzg.github.io/docker-minecraft-docs/) - ---- ## Intro @@ -31,6 +28,9 @@ where, in this case, the standard server port 25565, will be exposed on your hos By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](#versions) and the [`TYPE`](#server-types) can be configured to create many variations of desired Minecraft server. +
+Expand to see deprecated docs sections -- soon will be removed + ## Looking for a Bedrock Dedicated Server For Minecraft clients running on consoles, mobile, or native Windows, you'll need to @@ -1996,3 +1996,5 @@ To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags ## Contributing See [Development](DEVELOPMENT.md) and [Building](BUILDING.md). + +
diff --git a/docs/misc/autopause/index.md b/docs/misc/autopause-autostop/autopause.md similarity index 100% rename from docs/misc/autopause/index.md rename to docs/misc/autopause-autostop/autopause.md diff --git a/docs/misc/autopause/autostop.md b/docs/misc/autopause-autostop/autostop.md similarity index 100% rename from docs/misc/autopause/autostop.md rename to docs/misc/autopause-autostop/autostop.md diff --git a/BUILDING.md b/docs/misc/contributing/building.md similarity index 100% rename from BUILDING.md rename to docs/misc/contributing/building.md diff --git a/DEVELOPMENT.md b/docs/misc/contributing/development.md similarity index 88% rename from DEVELOPMENT.md rename to docs/misc/contributing/development.md index 230f6970..184c0340 100644 --- a/DEVELOPMENT.md +++ b/docs/misc/contributing/development.md @@ -2,11 +2,11 @@ Adding a new server `TYPE` can vary due to the complexity of obtaining and configuring each type; however, the addition of any server type includes at least the following steps: -1. Copy an existing "start-deploy*" script, such as [start-deployMohist](scripts/start-deployMohist) and rename it accordingly making sure to retain the "start-deploy" prefix +1. Copy an existing "start-deploy*" script, such as [start-deployFabric](https://github.com/itzg/docker-minecraft-server/blob/master/scripts/start-deployFabric) and rename it accordingly making sure to retain the "start-deploy" prefix 2. Modify the type-specific behavior between the "start-utils" preamble and the hand-off to `start-setupWorld` at the end of the script 3. Develop and test the changes using the [iterative process described below](#iterative-script-development) -4. Add a case-entry to the `case "${TYPE^^}"` in [start-configuration](scripts/start-configuration) -5. Add a section to the [README](README.md). It is recommended to copy-modify an existing section to retain a similar wording and level of detail +4. Add a case-entry to the `case "${TYPE^^}"` in [start-configuration](https://github.com/itzg/docker-minecraft-server/blob/master/scripts/start-configuration) +5. Add a section to the [docs](https://github.com/itzg/docker-minecraft-server/tree/master/docs). It is recommended to copy-modify an existing section to retain a similar wording and level of detail 6. [Submit a pull request](https://github.com/itzg/docker-minecraft-server/pulls) ## Iterative script development