diff --git a/docs/docs/developer/getting-started.md b/docs/docs/developer/getting-started.md new file mode 100644 index 000000000..f413252c8 --- /dev/null +++ b/docs/docs/developer/getting-started.md @@ -0,0 +1,8 @@ +# Getting started + +**Welcome!** We are glad to have you visit our developer guide! If you find any bugs or have suggestions for improvements, please open an [issue](https://github.com/bakdata/kpops/issues/new) and optionally a [pull request (PR)](https://github.com/bakdata/kpops/compare). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it. + +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 new file mode 100644 index 000000000..57977edf3 --- /dev/null +++ b/docs/docs/developer/style/markdown.md @@ -0,0 +1,10 @@ +# 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.md b/docs/docs/developer/style/python.md similarity index 63% rename from docs/docs/developer/style.md rename to docs/docs/developer/style/python.md index ef08e5ad3..0254e0830 100644 --- a/docs/docs/developer/style.md +++ b/docs/docs/developer/style/python.md @@ -1,27 +1,14 @@ -# Style - -## Python +# Python To ensure a consistent Python code style, we use [Ruff](https://docs.astral.sh/ruff/) for both linting and formatting. -### Configuration +## Configuration Our configuration can be found in [KPOps](https://github.com/bakdata/kpops)' top-level `pyproject.toml`. -### Editor integration +## 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) - -## 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 set up dprint. -The configuration can be found [here](https://github.com/bakdata/kpops/blob/main/dprint.json). diff --git a/docs/docs/stylesheets/extra.css b/docs/docs/stylesheets/extra.css index ae2953c82..5ab56028c 100644 --- a/docs/docs/stylesheets/extra.css +++ b/docs/docs/stylesheets/extra.css @@ -13,6 +13,8 @@ /* Color the links with the primary color */ --md-typeset-a-color: var(--md-primary-fg-color); + + --md-admonition-icon--wip: url('data:image/svg+xml;charset=utf-8,') } .md-typeset .md-button, .md-button--primary { @@ -22,3 +24,19 @@ .md-typeset .md-button:hover, .md-button--primary:hover { border-color: white; } + +.md-typeset .admonition.wip, +.md-typeset details.wip { +border-color: rgb(160, 45, 0); +} +.md-typeset .wip > .admonition-title, +.md-typeset .wip > summary { +background-color: rgb(255, 195, 172); +} +.md-typeset .wip > .admonition-title::before, +.md-typeset .wip > summary::before { +background-color: rgb(255, 77, 6); +-webkit-mask-image: var(--md-admonition-icon--wip); + mask-image: var(--md-admonition-icon--wip); +} + \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0b3da03bd..c4dec620b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -112,5 +112,9 @@ nav: - CI integration: - GitHub Actions: user/references/ci-integration/github-actions.md - Developer Guide: + - Getting Started: developer/getting-started.md + - Style: + - Python: developer/style/python.md + - Markdown: developer/style/markdown.md + - Code base: - Auto generation: developer/auto-generation.md - - Style: developer/style.md