merge: Restructure Docs (#18)

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/deploy.yml

@@ -1,31 +1,55 @@
-name: Deploy Site
+name: Deploy to GitHub Pages
 
 on:
+  workflow_dispatch:
   push:
-    paths: 
-    - 'docs/**'
-    - 'mkdocs.yml'
-    branches:
-    - master
+    branches: [master]
+    paths:
+      - .github/workflows/deploy.yml
+      - docs/**
+      - mkdocs.yml
+      - requirements.txt
+
+permissions:
+  actions: read
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: false
 
 jobs:
-  build:
-    runs-on: [ubuntu-latest]
+  buildAndDeploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }} # Used to report back the URL of the deploy.
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.7
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools
-        python -m pip install -r requirements.txt
-    - name: Deploy Files
-      run: |
-        git config user.name "github-actions[bot]"
-        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
-        git remote add gh-token "https://github.com/CodeMC/Documentation.git"
-        git fetch gh-token && git fetch gh-token gh-pages:gh-pages
-        python -m mkdocs gh-deploy --clean -m "Deploying Wiki to GitHub Pages (${GITHUB_SHA:0:7})" --remote-name gh-token
-        git push gh-token gh-pages
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Required for git-revision-date-localized plugin
+      - name: Setup Python 3.x
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install Dependencies
+        run: |
+          pip install -U pip setuptools
+          pip install -r requirements.txt
+      - name: Build Pages
+        run: mkdocs build
+        env:
+          GIT_COMMITTER_ENABLED: true # Used to enable Git Committers plugin
+          COMMITTER_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Used to increase rate limits for GitHub API.
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+      - name: Upload Pages Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+      - name: Deploy to GitHub Pages
+        id: deploy
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+# Ignore .cache folder created by git-committers plugin
+.cache/

README.md

@@ -2,15 +2,15 @@
 [discord]: https://discord.gg/AGcFMu6
 
 # Documentation
-A repository explaining how to make use of our Jenkins and Nexus instances.
+A repository explaining how to make use of our Jenkins and Nexus instances. The documentation is hosted over Cloudflare Pages.
 
 View documentation: [https://docs.codemc.io/](https://docs.codemc.io/)
 
 Jenkins CI: [https://ci.codemc.io](https://ci.codemc.io/)<br>
 Maven repository: [https://repo.codemc.io](https://repo.codemc.io/)
 
 ## About
-Welcome to CodeMC, a public Jenkins instance and Maven repository for open source Minecraft projects.
+Welcome to CodeMC, a public Jenkins instance and Maven repository for open-source Minecraft projects.
 If you want to add your build job to our instance please [contact us](#support-), we'd love to support your project(s)!
 
 ## Support ![badge]

docs/assets/css/styling.css

@@ -3,11 +3,15 @@
 }
 
 .md-header__button.md-logo img {
-  height: 2rem;
+  height: 2.5rem;
   width: auto;
 }
 
 .md-nav__title > .md-nav__button.md-logo img {
-  height: 2rem;
+  height: 2.5rem;
   width: auto;
 }
+
+[dir="ltr"] .md-header__title {
+  margin-left: 0;
+}

docs/faq/adding-your-project.md

@@ -0,0 +1,12 @@
+# How to add your project to CodeMC?
+
+CodeMC is open for join requests, as we want to offer a free and reliable CI-Service to everyone that needs one.
+
+In order to join will you need to join the [Discord Server](https://discord.gg/AGcFMu6). There, head to the `#request-access` channel and read the Pinned Message as it contains important info on what requirements you need to fulfill and how to request being added.
+
+/// note
+You are only required to make one join request with a project.  
+If you are accepted to the CI, you can create new projects by yourself without additional approval.
+
+Keep in mind however, that any new project you make needs to follow our [Usage Guidelines](../usage-guidelines.md) and that failing to do so may result in punishments outlined [here](../usage-guidelines.md#punishments).
+///

docs/faq/build-jdk-8-project.md

@@ -0,0 +1,31 @@
+# How do I build a Maven Project with JDK 8?
+
+Jenkins dropped official support for JDK 8 Maven builds. To still build projects using this Java version, you can either use our custom Maven plugin to select a JDK Toolchain based on your `maven-compiler-plugin` settings, or cross-compile with a newer JDK Version.
+
+## Toolchain Plugin
+
+Our custom Maven Plugin can select a toolchain (e.g. JDK 8) during the build process. For this, the following workaround is required:
+
+1.  Set the JDK version to JDK 11.
+2.  Add the following maven goal to the command line:  
+    `io.codemc.maven.plugins.toolchain:codemc-toolchain-selector:0.0.2-SNAPSHOT:select`
+
+## Cross-Compiling
+
+Cross-compiling is the process of targeting a different platform than the compiler itself.  
+In this case, it allows to use any JDK beyond Java 8 to generate a build that is still compatible with the older version.
+
+You can achieve this by using `source` and `target` in the `maven-compiler-plugin` configuration. However, the usage of `release` is recommended in order to verify that you don't use any Java API methods introduced in later Java versions:  
+
+```xml
+<plugins>
+  <plugin>
+    <groupId>org.apache.maven.plugins</groupId>
+    <artifactId>maven-compiler-plugin</artifactId>
+    <version>3.10.1</version> <!-- Make sure to update when necessary -->
+    <configuration>
+      <release>8</release>
+    </configuration>
+  </plugin>
+</plugins>
+```

docs/faq/cannot-access-folders.md

@@ -0,0 +1,4 @@
+# Why can I not access Job Configurations/Folders?
+
+This is usually only the case for organizations that have been added to CodeMC.  
+Should you encounter this with an organization, head over to your [Connection Settings on GitHub](https://github.com/settings/applications) and make sure you granted the [CodeMC Application](https://github.com/settings/connections/applications/2debe3b061b244423bf5) access to your User Account and Organization in question. This is indicated by a green checkmark next to the Organization displayed.

docs/faq/index.md

@@ -0,0 +1,37 @@
+# FAQ
+
+This section of the Wiki contains common questions you may have.
+
+<div class="grid cards" markdown>
+
+-   ### [How to add your project to CodeMC?](adding-your-project.md)
+
+    ----
+
+    How you can get your project added to the CodeMC Services and what you need to keep in mind.
+
+-   ### [Are non-Minecraft projects allowed?](non-mc-projects.md)
+
+    ----
+
+    Answers to the question wether only MC related projects are allowed or not.
+
+-   ### [Why can I not access Job Configurations/Folders?](cannot-access-folders.md)
+
+    ----
+
+    Common reasons for why you can't access a Job Configuration.
+
+-   ### [How to use the NMS Repository?](using-nms-repository.md)
+
+    ----
+
+    Information on how you can utilize the NMS Repository of CodeMC in your projects.
+
+-   ### [How do I build a Maven Project with JDK 8?](build-jdk-8-project.md)
+
+    ----
+
+    How you can build a project for and/or with Java 8 on the Jenkins Service of CodeMC.
+
+</div>

docs/faq/non-mc-projects.md

@@ -0,0 +1,6 @@
+# Are non-Minecraft projects allowed?
+
+**Short Answer:** Yes
+
+**Long Answer:** CodeMC accepts any Java (or Java-related) project that shows thorough quality and usefulness for the overall programming community, be it a library, software, or even a game. If you're using Kotlin or Scala, your project should compile to the JVM while continuing to provide services intended for the community.
+What matters is, that the project is following our [Usage Guidelines](../usage-guidelines.md) to remain on our Services.