29 lines
1.9 KiB
Markdown
29 lines
1.9 KiB
Markdown
# WeatherTool project documentation
|
|
|
|
This directory contains the working documentation for the WeatherTool modernization effort. The repository-root `README.md` is preserved as the original project overview; these documents describe the reviewed code, current staging environment, and changes being developed.
|
|
|
|
## Current status
|
|
|
|
- Development source is edited and tested on Windows.
|
|
- A production-like staging copy runs through Docker Compose on Rocky Linux at `http://192.168.1.101:9190`.
|
|
- Staging uses deterministic synthetic station observations for all 33 stations.
|
|
- Scheduled external-provider jobs are disabled in development and staging.
|
|
- PostgreSQL is private to the project Compose network; only the Scala application publishes a host port.
|
|
- UI modernization is in progress. City Analysis retains temperature-map outputs, while Faktiskā is a separate temperature-and-weather-symbol production workflow.
|
|
- This is not yet approved or hardened for workplace production.
|
|
|
|
## Documents
|
|
|
|
- [Architecture and data flow](ARCHITECTURE.md) — components, data sources, data flow, and repository layout.
|
|
- [Development and staging](DEVELOPMENT_AND_STAGING.md) — Git workflow, local build, Rocky deployment, synthetic data, verification, and rollback.
|
|
- [Product workflows](PRODUCT_WORKFLOWS.md) — the intended purpose and current status of each visible workspace.
|
|
- [Update roadmap](UPDATE_ROADMAP.md) — phased technical, security, dependency, testing, and UI work.
|
|
- [Third-party notices](THIRD_PARTY_NOTICES.md) — licenses and attribution for adapted interface components.
|
|
|
|
## Documentation rules
|
|
|
|
1. Do not put passwords, API keys, workplace URLs, or production data in Git.
|
|
2. Document the behavior that exists separately from behavior that is proposed.
|
|
3. Update these documents in the same commit when a change alters deployment, data flow, or a user workflow.
|
|
4. Keep synthetic/development instructions clearly distinguished from workplace production procedures.
|