From 62af44e8f09c1f5c9a9aae0d55e7464215c0cdf1 Mon Sep 17 00:00:00 2001 From: selfhoster1312 Date: Sun, 2 Mar 2025 16:48:17 +0100 Subject: [PATCH 1/4] fix: Add local dev dependencies (mkdocs/theme/sendria) --- pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index ad899e2..045d12a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,9 @@ build-backend = "setuptools.build_meta" [project.optional-dependencies] dev = [ + "mkdocs>=1.6", + "mkdocs-material>=9.6", + "sendria>=2.2", "pytest>=7,<8", "pip-tools>=6,<7", "pytest-isort>=3,<4", From 3ac88ee413f4bc6c2a2d28708b192433b921f686 Mon Sep 17 00:00:00 2001 From: selfhoster1312 Date: Sun, 2 Mar 2025 16:48:38 +0100 Subject: [PATCH 2/4] docs: Add internal to "Getting started" for selfhosting --- docs/deploy.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/deploy.md b/docs/deploy.md index a27e4b9..1d2c1b1 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -4,6 +4,7 @@ This page describes how the main instance is deployed, and is mainly meant as a way to share the knowledge. You can obviously do things differently. + See the [Getting Started](install.md) page for more information on selfhosting. ## Services From 97c49b90cb949ef7c888a842c334f2142c51bf67 Mon Sep 17 00:00:00 2001 From: selfhoster1312 Date: Sun, 2 Mar 2025 16:51:54 +0100 Subject: [PATCH 3/4] docs: Symlink CHANGELOG.md to docs/changelog.md --- CHANGELOG.md | 44 +------------------------------------------- docs/changelog.md | 44 ++++++++++++++++++++++++++++++++++++++------ 2 files changed, 39 insertions(+), 49 deletions(-) mode change 100644 => 120000 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index a688249..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,43 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -since 0.4.1, and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## 1.3.0 (2024-11-02) - -This is a small release, with a few features and bugfixes. The code is now -hosted on https://framagit.org rather than https://gitlab.com. - -### Added - -- Changed hour and date format in the generated CSV files -- Added the date in the grouped order dashboard -- Changed the display of the last possible date and hour to place an order -- Added the total number of ordered items in the grouped orders overview -- Removed header line and column for grouped order name in the CSV export for emails - -### Fixed - -- The "reset password" form is now fixed, it was broken since the last release. - -## 1.2.0 (2024-07-12) - -A small release, with a few features, a new footer and a `/stats` endpoint. - -### Added - -- Staff users are now able to see the overview page for a grouped order. -- Personal information are now autocompleted automatically -- A `/stats` endpoint has been added, making it possible to see some information - about the current instance. -- The footer has been changed to include more elements, links to the project and - documentation. - -### Development - -- The `main` branch is not used anymore, all the development happens on the -`develop` branch instead. -- All the tests have been grouped in the `tests` folder -- The `requirements.txt` file have been removed in favor of the `pyproject.toml` file. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 120000 index 0000000..1bed66b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +docs/changelog.md \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md index 42333f1..a688249 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,11 +1,43 @@ # Changelog -Given a version number `MAJOR`.`MINOR`.`PATCH`: +All notable changes to this project will be documented in this file. -- `MAJOR` is updated when there are **incompatible changes**, -- `MINOR` is updated when there are **backwards-compatible feature additions**, -- `PATCH` is updated when there are **backwards-compatible bug fixes**. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) +since 0.4.1, and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -### 1.0.0 (date) +## 1.3.0 (2024-11-02) -- Basic features. +This is a small release, with a few features and bugfixes. The code is now +hosted on https://framagit.org rather than https://gitlab.com. + +### Added + +- Changed hour and date format in the generated CSV files +- Added the date in the grouped order dashboard +- Changed the display of the last possible date and hour to place an order +- Added the total number of ordered items in the grouped orders overview +- Removed header line and column for grouped order name in the CSV export for emails + +### Fixed + +- The "reset password" form is now fixed, it was broken since the last release. + +## 1.2.0 (2024-07-12) + +A small release, with a few features, a new footer and a `/stats` endpoint. + +### Added + +- Staff users are now able to see the overview page for a grouped order. +- Personal information are now autocompleted automatically +- A `/stats` endpoint has been added, making it possible to see some information + about the current instance. +- The footer has been changed to include more elements, links to the project and + documentation. + +### Development + +- The `main` branch is not used anymore, all the development happens on the +`develop` branch instead. +- All the tests have been grouped in the `tests` folder +- The `requirements.txt` file have been removed in favor of the `pyproject.toml` file. From bc8f5459ae7e24b74dc685137e65b736161a07c2 Mon Sep 17 00:00:00 2001 From: selfhoster1312 Date: Sun, 2 Mar 2025 17:13:52 +0100 Subject: [PATCH 4/4] docs: Yarn and npm were mixed up --- docs/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/install.md b/docs/install.md index 32bf2dd..d62de81 100644 --- a/docs/install.md +++ b/docs/install.md @@ -32,13 +32,13 @@ pip install -e ".[dev]" And the frontend dependencies: -=== "Yarn" +=== "npm" ```bash npm install ``` -=== "npm" +=== "Yarn" ```bash yarn install ```