Skip to content

docs: rewrite README and contributing guide for public readers - #10

Draft
jm-rivera wants to merge 2 commits into
devfrom
docs/public-repo-docs
Draft

jm-rivera wants to merge 2 commits into
devfrom
docs/public-repo-docs

Conversation

@jm-rivera

Copy link
Copy Markdown
Contributor

Rewrites the README and contributing guide for a public reader and moves automation and ingestion settings into docs/development.md.

README.md now lists the eight covered datasets, each linking its transformations.md, and gives a local recipe for World Bank IDS that needs no cloud access. It states that only the *_dc_ingestion assets need ONE's dev-fin-observatory project. CONTRIBUTING.md gains the code of conduct and security links, says where to raise which kind of issue, and lists the exact CI checks. The automation section, the DCP_* and skills settings that only .env.example explained, the pinned dfo-ontology commit and a CI summary move to docs/development.md.

CONTRIBUTING.md links the organisation code of conduct, security policy and support guide by absolute URL. Those links resolve once DevelopmentFinanceObservatory/.github#1 merges.

The README uses dbt run and not dbt build for the local recipe. A single dg launch --assets '*world_bank_ids_dc_export' fails at the dbt step, because cross-dataset dbt tests query schemas of datasets that were never built. Making a one-command local run work is a code change for a separate PR.

Testing: pre-commit run --files passes on the three files. The World Bank IDS recipe ran end to end and wrote the observation CSVs under data/processed/world_bank_ids/.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant