Skip to content
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.

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

Restructure Docs #18

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
4 changes: 4 additions & 0 deletions docs/assets/css/styling.css
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@
height: 2rem;
width: auto;
}

[dir="ltr"] .md-header__title {
margin-left: 0;
}
99 changes: 0 additions & 99 deletions docs/faq.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/faq/adding-your-project.md
Original file line number Diff line number Diff line change
@@ -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).
///
31 changes: 31 additions & 0 deletions docs/faq/build-jdk-8-project.md
Original file line number Diff line number Diff line change
@@ -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>
```
4 changes: 4 additions & 0 deletions docs/faq/cannot-access-folders.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/faq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FAQ

This section of the Wiki contains common questions you may have.
6 changes: 6 additions & 0 deletions docs/faq/non-mc-projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Are non-Minecraft projects allowed?

**Short Answer:** Yes

**Long Answer:** CodeMC accepts any Java project that shows a level of quality and usefulness for the overall Java Community, be it a library, a software or even a game.
Andre601 marked this conversation as resolved.
Show resolved Hide resolved
What matters is, that the project is following our [Usage Guidelines](../usage-guidelines.md) to remain on our Services.
53 changes: 53 additions & 0 deletions docs/faq/using-nms-repository.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# How to use the NMS Repository?

CodeMC offers a NMS Repository that allows you to download and use specific NMS content from a particular version, without having to do things like running BuildTools yourself.
To use the Repository, add the below displayed content to your `pom.xml` or `build.gradle(.kts)` file.

/// info
Replace `{version}` with a matching version.
CodeMC follows the same version naming as Spigot and Paper do, so if you use `1.21-R0.1-SNAPSHOT` for Spigot can you use the same version for the NMS repository.
///

/// tab | :simple-apachemaven: pom.xml
```xml
<repositories>
<repository>
<id>codemc-nms-repository</id>
<url>https://repo.codemc.io/repository/nms/</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>org.spigotmc</groupId>
<artifactId>spigot</artifactId>
<version>{version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
///

/// tab | :simple-gradle: build.gradle
```groovy
repositories {
maven{ url = "https://repo.codemc.io/repository/nms/" }
}

dependencies {
compileOnly("org.spigotmc:spigot:{version}")
}
```
///

/// tab | :simple-gradle-kotlin: build.gradle.kts
```kotlin
repositories {
maven("https://repo.codemc.io/repository/nms/")
}

dependencies {
compileOnly("org.spigotmc:spigot:{version}")
}
```
///
38 changes: 30 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,33 @@
# Welcome to CodeMC
This site contains important pages around our CI site and how you can use it.

## Pages

- [FAQ](faq)
- [Jenkins](jenkins)
- [GitHub Integrations](jenkins/github-integration)
- [Creating a Gradle Job](jenkins/gradle)
- [Creating a Maven Job](jenkins/maven)
- [Deploy to the CodeMC Nexus](jenkins/deploy)
## Jenkins Docs

<div class="grid cards" markdown>

- ### [FAQ](faq/index.md)

----

Frequently asked questions about our Services.

- ### [CI Service](services/ci/index.md)

----

Our CI Service allows you to build new jars for your project.

- ### [Nexus Service](services/nexus/deploy.md)

----

CodeMC offers a Nexus for you to deploy your projects towards, so that others can use them.

- ### [Usage Guidelines](usage-guidelines.md)

----

We have specific rules and guidelines in place to keep a healthy ecosystem. Read them.

</div>

Loading