Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation - env vars and how to run dataset_ingress_v1 #72

Open
mikeAdamss opened this issue Mar 20, 2024 · 0 comments
Open

documentation - env vars and how to run dataset_ingress_v1 #72

mikeAdamss opened this issue Mar 20, 2024 · 0 comments

Comments

@mikeAdamss
Copy link
Contributor

mikeAdamss commented Mar 20, 2024

What is this

  • We need a list of env vars added to a table in the base of the repo to specify what env vars are in used by the pipelines as a "Configuration" table. Dont include webhook urls please, its a public repo. Here's an example markdown table for reference: https://github.com/ONSdigital/dp-dataset-api.

  • We need some documentation on how to run data_ingress_v1. Please put this in a readme in the ./dpypelines/pipeline` sub directory please (if there's an existing readme get it rid of it please, we need some clearer documentation). For context if you point it at a directory with a correct config file and some data on your local machine it should work. Please inlcude a high level description of what this function does.

NOTE - not a full user guide on how the code works, this is "how do you use it", starting from data_ingress_v1().

  • Can you check the readmes and remove any (really old) references to pipeline-config please.
@mikeAdamss mikeAdamss changed the title documentation - how to run dataset_ingress_v1 documentation - env vars and how to run dataset_ingress_v1 Apr 12, 2024
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

No branches or pull requests

1 participant