My  Fediverse Projects

Sites

Environment	URL	Badge
Staging	https://info.preview.hadan.social
Production	https://info.hadan.social

Participate

1. Make sure you are already have an account at https://git.hadan-it.com. If not pls be so kind to contact support@hadan-it.com.
2. Contact support@hadan-it.com to be granted access to the stephan.hadan.de-repository.

Development

Checkout this project:

git clone ssh://git@git.hadan-it.com:222/web/info.hadan.social.git

Install Python 3.13 with brew:

brew install python@3.13

Create a virtual environment at the project root - this is used to isolate project packages from the global packages.

$ python3.13 -m venv .venv

Activate the environment.

$ source venv/bin/activate

Install zensical with the following command:

$ pip install zensical

From time to time it is necessary to run the last command to update your zensical environment.

Upgrade to Python 3.13

Delete your venv folder inside your already existing checked out repository:

rm -rf .venv

After that, close your terminal session, create a new one, navigate to your repository again. Then: please continue with "Install Python 3.12 with brew" in the above paragraph and update your environment

Folder structure

.
├── CHANGELOG
├── LICENSE
├── README.md
├── docs
├── zensical.toml
├── overrides
├── renovate.json
├── requirements.txt
├── resources
└── .venv

Install dependencies for optimization function

TBD

Generate and preview full documentation locally

In the root of the checked out repository just use the following command to serve the documentation:

$ zensical serve

This will spin up your instance on port 8000 reacting on any changes you make until you stop the service with Ctrl+C

Contribute code/documentation

To ensure a reasonable joint development of the documentation, it is necessary to derive each change reasonably into a separately named branch. The following prefixes are available for this purpose:

• feat/ for new features/documentation
• hotfix/ for changes to existing documentation

Examples:

• feat/new-blog-post
• hotfix/translation-of-blog-entry

After the development of the branch has been completed and extensively tested locally, a corresponding merge request is created in the devel branch and approved by a colleague. This ensures a high quality of the documentation and the necessary review.

Once the request has been approved, it can be merged into the devel branch. An automatic build pipeline builds the new devel status on https://info.preview.hadan.social for reasons of overview, the source branch should be deleted accordingly during the merge.

A merge from Devel to Main and a deployment via a build pipeline to https://info.hadan.social takes place at regular intervals. This merge is only carried out after consultation.