Update the CONTRIBUTING file

Create sections in the documentation

docs/developer_documentation/contribute/api.md

@@ -0,0 +1,6 @@
+# Contribute to the API
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "## Contribute to the API"
+:end-before: "## Contribute to the frontend"
+```

docs/developer_documentation/contribute/copy.md

@@ -0,0 +1,6 @@
+# Update UI copy
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "## Update UI copy"
+:end-before: "## Git workflow"
+```

docs/developer_documentation/contribute/frontend.md

@@ -0,0 +1,6 @@
+# Contribute to the frontend
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "## Contribute to the frontend"
+:end-before: "## Update UI copy"
+```

docs/developer_documentation/contribute/index.md

@@ -0,0 +1,14 @@
+# Contribute to the Funkwhale codebase
+
+Funkwhale is an open source project, which means we welcome contributions from anyone! If you want to get involved with Funkwhale development, check the guides in this section.
+
+```{toctree}
+---
+maxdepth: 1
+---
+
+frontend
+copy
+api
+
+```

docs/developer_documentation/index.md

@@ -0,0 +1,15 @@
+# Developer documentation
+
+Funkwhale welcomes contributions from all developers. If this is your first time contributing to an open source project, don't be afraid to get stuck in! The Funkwhale community will guide you through the process and help you grow your confidence.
+
+## Set up your development environment
+
+Before you begin, you need to set up a development environment. Follow the [guides in the setup section](setup/index.md) to set up an environment that's right for you.
+
+## Read up on our processes
+
+The Funkwhale project follows a few processes to make managing contributions easier. If you're not sure how to get started, check out the [guides in the workflows section](workflows/index.md) to get a better understanding of what you need to do.
+
+## Contribute to the codebase
+
+Ready to get stuck in? Take a look at the [contribution guides](contribute/index.md) and start making your changes!

docs/developer_documentation/setup/docker.md

@@ -0,0 +1,8 @@
+# Develop using Docker
+
+```{include} ../../../CONTRIBUTING.md
+---
+start-after: "### Docker"
+end-before: "### Vite"
+---
+```

docs/developer_documentation/setup/gitpod.md

@@ -0,0 +1,6 @@
+# Develop using Gitpod
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "### Gitpod"
+:end-before: "### Docker"
+```

docs/developer_documentation/setup/index.md

@@ -0,0 +1,15 @@
+# Set up your development environment
+
+Follow the instructions in these guides to set up your development environment.
+
+```{toctree}
+---
+caption: Choose your setup
+maxdepth: 1
+---
+
+gitpod
+docker
+vite
+
+```

docs/developer_documentation/setup/vite.md

@@ -0,0 +1,8 @@
+# Develop using Vite
+
+```{include} ../../../CONTRIBUTING.md
+---
+start-after: "### Vite"
+end-before: "## Contribute to the API"
+---
+```

docs/developer_documentation/workflows/changelog.md

@@ -0,0 +1,6 @@
+# Changelog fragments
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "## Changelog fragments"
+:end-before: "## Make a release"
+```

docs/developer_documentation/workflows/git.md

@@ -0,0 +1,6 @@
+# Git workflow
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "## Git workflow"
+:end-before: "## Changelog fragments"
+```

docs/developer_documentation/workflows/index.md

@@ -0,0 +1,15 @@
+# Development workflows
+
+Funkwhale follows workflows for each area of development and release management. You can find a breakdown of these in this section.
+
+```{toctree}
+---
+caption: Workflows
+maxdepth: 1
+---
+
+git
+changelog
+release
+
+```

docs/developer_documentation/workflows/release.md

@@ -0,0 +1,5 @@
+# Make a release
+
+```{include} ../../../CONTRIBUTING.md
+:start-after: "## Make a release"
+```