diff --git a/docs/docs/developer/getting-started.md b/docs/docs/developer/getting-started.md index f413252c8..b5e78cc5e 100644 --- a/docs/docs/developer/getting-started.md +++ b/docs/docs/developer/getting-started.md @@ -4,5 +4,9 @@ Find more about our code-style or insights into KPOps' code base here in our developer guide. + + !!! wip "WIP" The developer guide is still under construction. If you have a question left unanswered here, feel free to ask it by opening an issue. + + diff --git a/docs/docs/developer/style/markdown.md b/docs/docs/developer/style/markdown.md deleted file mode 100644 index 57977edf3..000000000 --- a/docs/docs/developer/style/markdown.md +++ /dev/null @@ -1,10 +0,0 @@ -# Markdown - -To ensure a consistent markdown style, we use [dprint](https://dprint.dev) to check and reformat. - -```shell -dprint fmt -``` - -Use the [official documentation](https://dprint.dev/setup/) to setup dprint. -The configuration can be found [here](https://github.com/bakdata/kpops/blob/main/dprint.json). diff --git a/docs/docs/developer/style/python.md b/docs/docs/developer/style/python.md deleted file mode 100644 index 0254e0830..000000000 --- a/docs/docs/developer/style/python.md +++ /dev/null @@ -1,14 +0,0 @@ -# Python - -To ensure a consistent Python code style, we use [Ruff](https://docs.astral.sh/ruff/) for both linting and formatting. - -## Configuration - -Our configuration can be found in [KPOps](https://github.com/bakdata/kpops)' top-level `pyproject.toml`. - -## Editor integration - -Below are listed existing Ruff plugins/extensions for some of the most popular python IDEs. If you cannot find your Editor of choices or you want something more custom, [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) enables Ruff to be used in any editor that supports the LSP - -- [VSCode](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) -- [PyCharm](https://plugins.jetbrains.com/plugin/20574-ruff)