diff --git a/README.md b/README.md index 7dec627..c5bb9c8 100644 --- a/README.md +++ b/README.md @@ -151,21 +151,15 @@ pixi run pre-commit-install ### Running the ETL Pipeline -````bash +```bash # Create environment file from template cp resources/docker/.env.example resources/docker/.env -<<<<<<< docs-improvement -```bash # 1. Start all services (PostgreSQL, Prefect server, worker) -======= -# Start all services (PostgreSQL, Prefect server, worker) ->>>>>>> main pixi run start-services -# Deploy and run ETL flows +# 2. Deploy ETL flows pixi run deploy -<<<<<<< docs-improvement # 3. Apply any pending database migrations # Note: start-services automatically applies migrations at startup via the @@ -180,12 +174,7 @@ pixi run run-etl # Stop services pixi run teardown-services -======= -pixi run run-etl - -# Monitor via Prefect UI at http://localhost:4200 ->>>>>>> main -```` +``` ### Running the Web Service @@ -208,18 +197,15 @@ pixi run -e docs docs-serve ## Contributing -See [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) for general contribution -guidelines (branching, PRs, commit style, pre-commit setup). +See [CONTRIBUTING.md](CONTRIBUTING.md) for general contribution guidelines +(branching, PRs, commit style, pre-commit setup). Each namespace package also has its own contributing guide with component-specific details: -- [`docs/datamodels/CONTRIBUTING.md`](docs/datamodels/CONTRIBUTING.md) -- Data - models and database schema -- [`docs/pipeline/CONTRIBUTING.md`](docs/pipeline/CONTRIBUTING.md) -- ETL - pipeline and Prefect workflows -- [`docs/webservice/CONTRIBUTING.md`](docs/webservice/CONTRIBUTING.md) -- - FastAPI web service +- [Datamodels](datamodels/CONTRIBUTING.md): Data models and database schema +- [Pipeline](pipeline/CONTRIBUTING.md): ETL pipeline and Prefect workflows +- [Webservice](webservice/CONTRIBUTING.md): FastAPI web service ## Acknowledgement diff --git a/datamodels b/datamodels new file mode 120000 index 0000000..f35117e --- /dev/null +++ b/datamodels @@ -0,0 +1 @@ +docs/datamodels \ No newline at end of file diff --git a/docs/LICENSE b/docs/LICENSE new file mode 120000 index 0000000..ea5b606 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1 @@ +../LICENSE \ No newline at end of file diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 120000 index 0000000..9d57138 --- /dev/null +++ b/docs/SECURITY.md @@ -0,0 +1 @@ +../SECURITY.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 766e77c..6bec8a9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -78,4 +78,5 @@ nav: - Changelog: CHANGELOG.md - Contributing: CONTRIBUTING.md - Code of Conduct: CODE_OF_CONDUCT.md - - ERD View: ERD_VIEW.md + - Security: SECURITY.md + - License: LICENSE diff --git a/pipeline b/pipeline new file mode 120000 index 0000000..1a2a335 --- /dev/null +++ b/pipeline @@ -0,0 +1 @@ +docs/pipeline \ No newline at end of file diff --git a/webservice b/webservice new file mode 120000 index 0000000..21b381e --- /dev/null +++ b/webservice @@ -0,0 +1 @@ +docs/webservice \ No newline at end of file