Skip to content

Latest commit

 

History

History
252 lines (155 loc) · 9.53 KB

contributing.md

File metadata and controls

252 lines (155 loc) · 9.53 KB
Raw
title description
Contribution Guidelines
Guidelines for contributions to the Fabric Documentation.

Contribution Guidelines {#contributing}

This website uses VitePress to generate static HTML from various Markdown files. You should familiarize yourself with the Markdown extensions that VitePress supports here.

There are three ways you can contribute to this website:

All contributions must follow our style guidelines.

Translating Documentation {#translating-documentation}

If you want to translate the documentation into your language, you can do this on the Fabric Crowdin page.

new-content Contributing Content {#contributing-content}

Content contributions are the main way to contribute to the Fabric Documentation.

All content contributions go through the following stages, each of which is associated with a label:

  1. locally Prepare your changes and push a PR
  2. stage:expansion: Guidance for Expansion if needed
  3. stage:verification: Content verification
  4. stage:cleanup: Grammar, Linting...
  5. stage:ready: Ready to be merged!

All content must follow our style guidelines.

1. Prepare Your Changes {#1-prepare-your-changes}

This website is open-source, and it is developed in a GitHub repository, which means that we rely on the GitHub flow:

  1. Fork the GitHub repository
  2. Create a new branch on your fork
  3. Make your changes on that branch
  4. Open a Pull Request to the original repository

You can read more about the GitHub flow here.

You can either make changes from the web UI on GitHub, or you can develop and preview the website locally.

Cloning Your Fork {#clone-your-fork}

If you want to develop locally, you will need to install Git.

After that, clone your fork of the repository with:

# make sure to replace "your-username" with your actual username
git clone https://github.com/your-username/fabric-docs.git

Installing Dependencies {#install-dependencies}

If you want to preview your changes locally, you will need to install Node.js 18+.

After that, make sure to install all dependencies with:

npm install

Running the Development Server {#run-the-development-server}

This will allow you to preview your changes locally at localhost:5173 and will automatically reload the page when you make changes.

npm run dev

Now you can open and browse the website from the browser by visiting http://localhost:5173.

Building the Website {#building-the-website}

This will compile all Markdown files into static HTML files and place them in .vitepress/dist:

npm run build

Previewing the Built Website {#previewing-the-built-website}

This will start a local server on port 4173 serving the content found in .vitepress/dist:

npm run preview

Opening a Pull Request {#opening-a-pull-request}

Once you're happy with your changes, you may push your changes:

git add .
git commit -m "Description of your changes"
git push

Then, follow the link in the output of git push to open a PR.

2. stage:expansion Guidance for Expansion if Needed {#2-guidance-for-expansion-if-needed}

If the documentation team thinks that you could expand upon your pull request, a member of the team will add the stage:expansion label to your pull request alongside a comment explaining what they think you could expand upon. If you agree with the suggestion, you can expand upon your pull request.

If you do not want to expand upon your pull request, but you are happy for someone else to expand upon it at a later date, you should create an issue on the Issues page and explain what you think could be expanded upon. The documentation team will then add the help-wanted label to your PR.

3. stage:verification Content Verification {#3-content-verification}

This is the most important stage as it ensures that the content is accurate and follows the Fabric Documentation style guide.

In this stage, the following questions should be answered:

  • Is all of the content correct?
  • Is all of the content up-to-date?
  • Does the content cover all cases, such as different operating systems?

4. stage:cleanup Cleanup {#4-cleanup}

In this stage, the following happens:

  • Fixing of any grammar issues using LanguageTool
  • Linting of all Markdown files using markdownlint
  • Formatting of all Java code using Checkstyle
  • Other miscellaneous fixes or improvements

framework Contributing Framework {#contributing-framework}

Framework refers to the internal structure of the website, any pull requests that modify the framework of the website will be labeled with the framework label.

You should really only make framework pull requests after consulting with the documentation team on the Fabric Discord or via an issue.

::: info Modifying sidebar files and the navigation bar configuration does not count as a framework pull request. :::

Style Guidelines {#style-guidelines}

If you are unsure about anything, you can ask in the Fabric Discord or via GitHub Discussions.

Write the Original in American English {#write-the-original-in-american-english}

All original documentation is written in English, following the American rules of grammar.

Add Data to the Frontmatter {#add-data-to-the-frontmatter}

Each page must have a title and a description in the frontmatter.

Remember to also add your GitHub username to authors in the frontmatter of the Markdown file! This way we can give you proper credit.

---
title: Title of the Page
description: This is the description of the page.
authors:
  - your-username
---

# Title of the Page {#title-of-the-page}

...

Add Anchors to Headings {#add-anchors-to-headings}

Each heading must have an anchor, which is used to link to that heading:

# This Is a Heading {#this-is-a-heading}

The anchor must use lowercase characters, numbers and dashes.

Place Code Within the /reference Mod {#place-code-within-the-reference-mod}

If you create or modify pages containing code, place the code in an appropriate location within the reference mod (located in the /reference folder of the repository). Then, use the code snippet feature offered by VitePress to embed the code.

For example, to highlight lines 15-21 of the FabricDocsReference.java file from the reference mod:

::: code-group

<<< @/reference/latest/src/main/java/com/example/docs/FabricDocsReference.java{15-21}

<<< @/reference/latest/src/main/java/com/example/docs/FabricDocsReference.java{15-21}[java]

:::

If you need a greater span of control, you can use the transclude feature from markdown-it-vuepress-code-snippet-enhanced.

For example, this will embed the sections of the file above that are marked with the #entrypoint tag:

::: code-group

@[code transcludeWith=#entrypoint](@/reference/latest/src/main/java/com/example/docs/FabricDocsReference.java)

@code transcludeWith=#entrypoint

:::

Create a Sidebar for Each New Section {#create-a-sidebar-for-each-new-section}

If you're creating a new section, you should create a new sidebar in the .vitepress/sidebars folder and add it to the i18n.mts file.

If you need assistance with this, please ask in the Fabric Discord's #docs channel.

Add New Pages to the Relevant Sidebars {#add-new-pages-to-the-relevant-sidebars}

When creating a new page, you should add it to the relevant sidebar in the .vitepress/sidebars folder.

Again, if you need assistance, ask in the Fabric Discord in the #docs channel.

Place Media in /assets {#place-media-in-assets}

Any images should be placed in a suitable place in the /public/assets folder.

Use Relative Links! {#use-relative-links}

This is because of the versioning system in place, which will process the links to add the version beforehand. If you use absolute links, the version number will not be added to the link.

You must also not add the file extension to the link either.

For example, to link to the page found in /players/index.md from the page /develop/index.md, you would have to do the following:

::: code-group

This is a relative link!
[Page](../players/index)

This is an absolute link.
[Page](/players/index)

This relative link has the file extension.
[Page](../players/index.md)

:::