Skip to content

chore: document application setup for Freiburg#108

Merged
mirdono merged 11 commits into
chore/document-app-setupfrom
chore/document-app-setup-freiburg
May 28, 2026
Merged

chore: document application setup for Freiburg#108
mirdono merged 11 commits into
chore/document-app-setupfrom
chore/document-app-setup-freiburg

Conversation

@mirdono
Copy link
Copy Markdown
Member

@mirdono mirdono commented May 26, 2026

This PR extends the previously added partner documentation for the city of Freiburg. They are primarily interested in UC0.0, harvesting via OParl, and UC1 concerning Restricted Mobility Zones.

Proposed approach

This builds upon the documentation added in #101. Primarily it extends the overall README with (more) information on harvesting data via OParl and UC1. The partner-oriented README was extend with some Freiburg-specific information. Finally, a Freiburg-specific docker-compose override override was added. This configuration (partially) disables services that are not relevant for Freiburg and contains some template configuration for services that are relevant.

How to test

  • Read all added documentation and assess whether it is factually correct and
    complete.
  • Add the Bamberg-specific docker compose override to your .env and ensure the
    stack can be properly started. Note, it is expected that some services do not
    function correctly due to placeholder values in their configuration.

Notes

  • The example configuration for AI service's API keys may be subject to change depending on the following PRs:

Related tickets

  • LBRON-1458

@mirdono mirdono added the documentation Improvements or additions to documentation label May 26, 2026
@mirdono mirdono self-assigned this May 26, 2026
@mirdono mirdono force-pushed the chore/document-app-setup branch from e669c1d to 787f1e9 Compare May 27, 2026 09:45
@mirdono mirdono force-pushed the chore/document-app-setup-freiburg branch 2 times, most recently from 2ece70a to 1a86a19 Compare May 27, 2026 10:02
@mirdono mirdono force-pushed the chore/document-app-setup branch from 787f1e9 to bd15f83 Compare May 27, 2026 11:47
@mirdono mirdono force-pushed the chore/document-app-setup-freiburg branch 2 times, most recently from b71afea to b2bf8f1 Compare May 27, 2026 11:55
@mirdono mirdono force-pushed the chore/document-app-setup branch from bd15f83 to 353ad03 Compare May 27, 2026 12:16
@mirdono mirdono force-pushed the chore/document-app-setup-freiburg branch from b2bf8f1 to d74496a Compare May 27, 2026 13:16
@mirdono mirdono merged commit 7bdaf9f into chore/document-app-setup May 28, 2026
@mirdono
Copy link
Copy Markdown
Member Author

mirdono commented May 28, 2026

As discussed on standup of 28 May 2026, merged without explicit review as we want to get it out to the partners.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant