Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/content/development/branching.excalidraw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/content/development/branching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Branching

`develop` is the main development branch.

Feature branches are always created from `develop`.

The `master` branch is updated only through merge requests from `develop` or via dedicated `hotfix` branches for critical fixes.

![None](./branching.excalidraw.svg)
2 changes: 2 additions & 0 deletions docs/content/development/cd.excalidraw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/content/development/ci-cd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CI / CD

## CI

![None](./ci.excalidraw.svg)

## CD

![None](./cd.excalidraw.svg)
2 changes: 2 additions & 0 deletions docs/content/development/ci.excalidraw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/content/development/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Release checklist

Applies by release type: **M** major; **m** minor; **b** bugfix

## On PR

| Task | M | m | b |
| --- | --- | --- | --- |
| Bump the Python bugfix version in the Dockerfile (if possible) | ✓ | ✓ | |
| Verify images in the latest [docs.impulse.bot](https://docs.impulse.bot) | ✓ | ✓ | |

## After merge to `master`

| Task | M | m | b |
| --- | --- | --- | --- |
| Check migrations on prod | ✓ | ✓ | ✓ |
| Create a GitHub release | ✓ | ✓ | ✓ |
| Close the GitHub milestone | ✓ | ✓ | ✓ |

## After release

| Task | M | m | b |
| --- | --- | --- | --- |
| Create Community Helm Chart release | ✓ | ✓ | ✓ |
| Update the Features section on the website | ✓ | ✓ | |
7 changes: 7 additions & 0 deletions docs/content/development/rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Development Rules

1. All **documentation** changes must be made as part of a feature, bug fix, or other related change.

Documentation should not be updated independently from the change it describes.

2. Features that are not covered by automated tests and may break existing functionality must be **manually tested** before being merged into `develop`.
2 changes: 1 addition & 1 deletion docs/listen.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash

. venv/bin/activate
. .venv/bin/activate
mkdocs serve -a 0.0.0.0:8000
5 changes: 5 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ nav:
- concepts/messengers.md
- concepts/special_variables.md
- concepts/templates.md
- Development:
- development/branching.md
- development/ci-cd.md
- development/rules.md
- development/release.md
- IMPULSE SERVER:
- installation.md
- Configuration:
Expand Down
Loading