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

Running Prefect Flows doc edits #192

Open
orianac opened this issue May 13, 2022 · 0 comments
Open

Running Prefect Flows doc edits #192

orianac opened this issue May 13, 2022 · 0 comments

Comments

@orianac
Copy link
Member

orianac commented May 13, 2022

Adding some requests for more info/additional clarification here:

  • make all paths (e.g. runtimes.py) relative for repo so we know exactly where it is
  • make a distinction in the set-up of the repo that the only thing a user needs to set-up not contained in the repo is (1) a .yml file and (2) any environment variables. (if we are trending away from using a yml file then specify that as well)
  • include a sample yaml file with the exact path where that file is located (with any sensitive information obfuscated) including if the name of the file has to look a certain way
  • include a sample environment variable set-up, the file location where those options are specified (with any sensitive information obfuscated) and the name of the file
  • in the running a flow section, add a sample parameter file, with each parameter detailed (and whether it's relevant or not for each downscaling method). This might be done easiest by just adding documentation to the generate_valid_json_parameters.ipynb notebook and adding a link to that notebook into the docs here. that way if we change the parameters in the notebook we won't have to remember to update the parameter description in this doc.
  • and an explanation of any programmatic tools we have for creating parameter files
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