Skip to content

Commit

Permalink
Add "under construction" warning to incomplete pages
Browse files Browse the repository at this point in the history
  • Loading branch information
FluxCapacitor2 committed Mar 11, 2024
1 parent 36ffaf8 commit ca955dd
Show file tree
Hide file tree
Showing 26 changed files with 165 additions and 32 deletions.
6 changes: 6 additions & 0 deletions src/content/docs/guides/creating-a-game.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Creating a New Game
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
10 changes: 5 additions & 5 deletions src/content/docs/guides/dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Development Environment Setup
description: How to work on BlueDragon in development mode
---

## Limitations

Working in development mode means that you cannot use or test any features that rely on messaging, like parties and matchmaking.

## Setup
:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
3 changes: 0 additions & 3 deletions src/content/docs/guides/production-env.md

This file was deleted.

8 changes: 7 additions & 1 deletion src/content/docs/modules/AnvilFileMapProviderModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: AnvilFileMapProviderModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/CombatZonesModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: CombatZonesModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/CosmeticsModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: CosmeticsModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 6 additions & 2 deletions src/content/docs/modules/CutsceneModule.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
title: CutsceneModule
---
`CutsceneModule` allows cutscenes to be defined and played. A *cutscene* is a set of points that, when played, will smoothly animate the player's position between them.
> ⚠️ This module is **experimental**, and its behavior is likely to change over time.

`CutsceneModule` allows cutscenes to be defined and played. A _cutscene_ is a set of points that, when played, will smoothly animate the player's position between them.

:::caution[Experimental]
This module is **experimental**, and its behavior is likely to change over time.
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/DoubleJumpModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: DoubleJumpModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/FireworkRocketModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: FireworkRocketModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/GlobalCosmeticModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: GlobalCosmeticModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/GuiModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: GuiModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/InstanceTimeModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: InstanceTimeModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/InstantRespawnModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: InstantRespawnModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/InventoryPermissionsModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: InventoryPermissionsModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/KitsModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: KitsModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/MapZonesModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: MapZonesModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/NPCModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: NPCModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/ShopModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: ShopModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/SidebarModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: SidebarModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/StatisticsModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: StatisticsModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/TeamModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: TeamModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/modules/TimedRespawnModule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: TimedRespawnModule
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
4 changes: 2 additions & 2 deletions src/content/docs/reference/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ If the `BLUEDRAGON_ENV_TYPE` is not set, the fallback is to check for a director
## Environment Variable Reference

| Environment variable | Defaults | Description |
| ------------------------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
| ------------------------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `BLUEDRAGON_QUEUE_TYPE` | **Dev**: `TEST`<br>**Prod**: `IPC` | Use "IPC" to connect to Puffin for queueing, or "TEST" for a fully-local/single-instance queue |
| `BLUEDRAGON_MONGO_CONNECTION_STRING` | **Dev**: `mongodb://localhost:27017`<br>**Prod**: `mongodb://mongo:27017` | The hostname that resolves to a MongoDB instance |
| `BLUEDRAGON_PUFFIN_HOSTNAME` | **Dev**: `localhost`<br>**Prod**: `puffin` | The hostname that resolves to a Puffin instance |
| `BLUEDRAGON_PUFFIN_PORT` | 50051 | 50051 | The port of Puffin's gRPC server. |
| `BLUEDRAGON_PUFFIN_PORT` | 50051 | The port of Puffin's gRPC server. |
| `BLUEDRAGON_LUCKPERMS_HOSTNAME` | **Dev**: `http://localhost:8080`<br>**Prod**: `http://luckperms:8080` | The hostname that resolves to a [standalone LuckPerms](https://luckperms.net/) instance |
| `BLUEDRAGON_DEFAULT_GAME` | `lobby` | The game to automatically create on startup. Typically used to immediately initialize a lobby on each game server. |
| `BLUEDRAGON_AGONES_DISABLED` | _Not set_ | If this environment variable is present with any value, Agones integration will be disabled. |
Expand Down
8 changes: 7 additions & 1 deletion src/content/docs/reference/lobby.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Lobby System
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
8 changes: 7 additions & 1 deletion src/content/docs/reference/queue.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Queue System
---
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::
6 changes: 6 additions & 0 deletions src/content/docs/reference/worlds-folder.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@
title: Worlds Folder
description: The file structure and required files in the server's worlds directory.
---

:::caution[Under Construction]
This page is under construction and may not be complete yet.
If you run into any issues, please [open an issue](https://github.com/BlueDragonMC/Docs/issues)
or contact us on [Discord](https://bluedragonmc.com/discord).
:::

0 comments on commit ca955dd

Please sign in to comment.