stefanzilske / bpm-crafters Goto Github PK

BPM-Crafters Website and Documentation

Report Bug · Request Feature

This repository contains the BPM-Crafters website as well as various best-practices and the api-client-documentation which can be found under https://bpm-crafters.github.io/website/

All changes have to be done in a separate Branch. As soon as the changes are done please open a PR. A GitHub Action runs with every commit to a Branch and checks if the documentation can be built. If you create a new branch make sure to name it according to what it does (e.g. feat/xyz or fix/xyz). Please use semantic commit messages as described in here.

Name Markdown files according to the title. This makes it easier to find a file. Avoid non-alphanumeric characters in titles. Use the file name as an internal document id to reference in the appropriate sidebars file.

We will be using the writing style guide defined by Camunda. It outlines writing techniques and practices to ensure uniform styling across documentation and to yield a more cohesive and organized user experience.

npm install

npm run start

Have you pulled latest from main? Have you run npm install? When we update dependencies in the project, they don't automatically get updated in your environment. You'll need to run npm install occasionally to acquire dependency updates locally.

If you have created a new file for the documentation you always need to make sure that it contains a proper header:

---
id: best-practices-overview
title: Best Practices Overview
sidebar_label: Overview
description: "This section provides an overview of the different BPM Best Pracitces."
---

If the page should show up in the sidebar it needs to be added to the sidebar.js. By default, this should always be the case.

This documentation is built using Docusaurus 3, a modern static website generator. The framework is well documented and is used by many (open source) projects. The documentation can be customized by setting parameters in docusaurus.config.js. Parameters are described here: https://v2.docusaurus.io/docs/docusaurus.config.js.