Skip to content

Split developers and server admin docs #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
e-im wants to merge 2 commits into from
Closed

Split developers and server admin docs #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1edefb
Split developers and server admin docs
e-im Apr 10, 2022
cb241d0
remove and replace outdated slugs
e-im Apr 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions config/navbar.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,38 @@ const navbar: Omit<Navbar, "style" | "hideOnScroll"> = {
},
items: [
{
to: "paper",
type: "dropdown",
label: "Paper",
position: "left",
items: [
{
type: "doc",
label: "Server Administrator",
docId: "paper/README",
},
{
type: "doc",
label: "Developer",
docId: "dev/paper/README",
},
],
},
{
to: "velocity",
type: "dropdown",
label: "Velocity",
position: "left",
items: [
{
type: "doc",
label: "Server Administrator",
docId: "velocity/README",
},
{
type: "doc",
label: "Developer",
docId: "dev/velocity/README",
},
],
},
{
to: "waterfall",
Expand Down
148 changes: 70 additions & 78 deletions config/sidebars.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,7 @@
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";

const sidebars: SidebarsConfig = {
docs: [
{
type: "category",
label: "Getting Help",
items: [
{
type: "link",
label: "Discord",
href: "https://discord.gg/papermc",
},
{
type: "link",
label: "Forums",
href: "https://forums.papermc.io",
},
],
},
"README",
admin: [
{
type: "category",
label: "Paper",
Expand All @@ -45,7 +28,7 @@ const sidebars: SidebarsConfig = {
label: "How-to Guides",
link: {
type: "generated-index",
slug: "/category/paper/how-to-guides",
slug: "category//paper/how-to-guides",
},
items: [
"paper/how-to/per-world-configuration",
Expand All @@ -59,7 +42,7 @@ const sidebars: SidebarsConfig = {
label: "Reference",
link: {
type: "generated-index",
slug: "/category/paper/reference",
slug: "category//paper/reference",
},
items: [
"paper/reference/paper-global-configuration",
Expand Down Expand Up @@ -95,7 +78,7 @@ const sidebars: SidebarsConfig = {
label: "How-to Guides",
link: {
type: "generated-index",
slug: "/category/velocity/how-to-guides",
slug: "category//velocity/how-to-guides",
},
items: [
"velocity/how-to/security",
Expand All @@ -108,7 +91,7 @@ const sidebars: SidebarsConfig = {
label: "Reference",
link: {
type: "generated-index",
slug: "/category/velocity/reference",
slug: "category//velocity/reference",
},
items: [
"velocity/reference/configuration",
Expand All @@ -118,55 +101,6 @@ const sidebars: SidebarsConfig = {
"velocity/reference/libraries",
],
},
{
type: "category",
label: "Developers",
link: {
type: "doc",
id: "velocity/developers/README",
},
items: [
{ type: "ref", id: "velocity/developers/README" },
{
type: "category",
label: "Getting Started",
link: {
type: "generated-index",
slug: "/category/velocity/developers/getting-started",
},
items: [
"velocity/developers/getting-started/creating-your-first-plugin",
"velocity/developers/getting-started/api-basics",
"velocity/developers/getting-started/pitfalls",
],
},
{
type: "category",
label: "How-to Guides",
link: {
type: "generated-index",
slug: "/category/velocity/developers/how-to-guides",
},
items: [
"velocity/developers/how-to/dependencies",
"velocity/developers/how-to/porting-from-velocity-1",
],
},
{
type: "category",
label: "API",
link: {
type: "generated-index",
slug: "/category/velocity/developers/api",
},
items: [
"velocity/developers/api/event",
"velocity/developers/api/command",
"velocity/developers/api/scheduler",
],
},
],
},
],
},
{
Expand All @@ -183,20 +117,78 @@ const sidebars: SidebarsConfig = {
label: "Common",
link: {
type: "generated-index",
slug: "/category/common",
slug: "category/common",
description: "Documentation relevant to all PaperMC projects.",
},
items: ["common/java-install"],
items: ["common/java-install", "common/downloads-api", "common/assets", "common/contact"],
},
],
dev: [
{
type: "category",
label: "PaperMC",
label: "Paper",
link: {
type: "generated-index",
slug: "/category/papermc",
description: "Information about the PaperMC Organization.",
type: "doc",
id: "dev/paper/README",
},
items: [
{
type: "ref",
id: "dev/paper/README",
},
],
},
{
type: "category",
label: "Velocity",
link: {
type: "doc",
id: "dev/velocity/README",
},
items: ["papermc/downloads-api", "papermc/assets", "papermc/contact"],
items: [
{
type: "ref",
id: "dev/velocity/README",
},
{
type: "category",
label: "Getting Started",
link: {
type: "generated-index",
slug: "category/dev/velocity/getting-started",
},
items: [
"dev/velocity/getting-started/creating-your-first-plugin",
"dev/velocity/getting-started/api-basics",
"dev/velocity/getting-started/pitfalls",
],
},
{
type: "category",
label: "How-to Guides",
link: {
type: "generated-index",
slug: "category/dev/velocity/how-to-guides",
},
items: [
"dev/velocity/how-to/dependencies",
"dev/velocity/how-to/porting-from-velocity-1",
],
},
{
type: "category",
label: "API",
link: {
type: "generated-index",
slug: "category/dev/velocity/api",
},
items: [
"dev/velocity/api/event",
"dev/velocity/api/command",
"dev/velocity/api/scheduler",
],
},
],
},
],
};
Expand Down
22 changes: 0 additions & 22 deletions docs/README.md
View file
Open in desktop

This file was deleted.

0 docs/papermc/assets.md → docs/common/assets.md
View file
Open in desktop
File renamed without changes.
0 docs/papermc/contact.md → docs/common/contact.md
View file
Open in desktop
File renamed without changes.
0 docs/papermc/downloads-api.md → docs/common/downloads-api.md
View file
Open in desktop
File renamed without changes.
0 docs/papermc/papermc_logomark_500.png → docs/common/papermc_logomark_500.png
View file
Open in desktop
File renamed without changes
3 changes: 3 additions & 0 deletions docs/dev/paper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Paper Developers Guide

Welcome to the Paper developer guide! TODO
0 docs/velocity/developers/README.md → docs/dev/velocity/README.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/velocity/developers/api/command.md → docs/dev/velocity/api/command.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/command-api
slug: /dev/velocity/command-api
---

# The Command API
Expand Down
2 changes: 1 addition & 1 deletion docs/velocity/developers/api/event.md → docs/dev/velocity/api/event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/event-api
slug: /dev/velocity/event-api
---

# Working With Events
Expand Down
2 changes: 1 addition & 1 deletion docs/velocity/developers/api/scheduler.md → docs/dev/velocity/api/scheduler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/scheduler-api
slug: /dev/velocity/scheduler-api
---

# Using the Scheduler
Expand Down
2 changes: 1 addition & 1 deletion .../developers/getting-started/api-basics.md → ...ev/velocity/getting-started/api-basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/api-basics
slug: /dev/velocity/api-basics
---

# Velocity Plugin Basics
Expand Down
2 changes: 1 addition & 1 deletion ...ing-started/creating-your-first-plugin.md → ...ing-started/creating-your-first-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/creating-your-first-plugin
slug: /dev/velocity/creating-your-first-plugin
---

# Creating Your First Plugin
Expand Down
2 changes: 1 addition & 1 deletion ...ty/developers/getting-started/pitfalls.md → .../dev/velocity/getting-started/pitfalls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/pitfalls
slug: /dev/velocity/pitfalls
---

# Common Pitfalls
Expand Down
2 changes: 1 addition & 1 deletion ...elocity/developers/how-to/dependencies.md → docs/dev/velocity/how-to/dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/dependency-management
slug: /dev/velocity/dependency-management
---

# Dependency Management
Expand Down
2 changes: 1 addition & 1 deletion ...elopers/how-to/porting-from-velocity-1.md → ...elocity/how-to/porting-from-velocity-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: /velocity/developers/porting-plugins-from-velocity-1
slug: /dev/velocity/porting-plugins-from-velocity-1
---

# Porting Your Plugin from Velocity 1.x.x
Expand Down
1 change: 0 additions & 1 deletion docs/paper/reference/paper-global-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
slug: /paper/reference/paper-global-configuration
keywords:
- paper.yml
- paper.yml settings
Expand Down
1 change: 0 additions & 1 deletion docs/paper/reference/paper-per-world-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
slug: /paper/reference/paper-per-world-configuration
keywords:
- paper.yml
- paper.yml world-settings
Expand Down
Loading