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

New location for Data Sets subtopic #60

Open
sarahhaggarty opened this issue Jul 28, 2021 · 2 comments
Open

New location for Data Sets subtopic #60

sarahhaggarty opened this issue Jul 28, 2021 · 2 comments

Comments

@sarahhaggarty
Copy link
Contributor

sarahhaggarty commented Jul 28, 2021

What does the current documentation state?
In the first steps of setting up the FLINT development environment the documentation introduces the subtopic of Data Sets.

Where is this stated?
On FLINT Development Setup page (DevelopmentSetup\index.rst).

Why do you want to improve the statement?
This is not the right place to introduce this as the reader hasn't started installation of FLINT yet. It should be treated as it's own topic and introduced after installation is successful and the reader understands how to run simulations.

Proposed statement
I originally proposed to move this subtopic as part of #58 under the section for FLINT.example after the instructions on how to run the different modules. However, after discussion with @chicken-biryani and @shubhamkarande13 I agree with them that this is also not the best place.

Possibilities that we discussed:

  • Remove it from installation instructions and move it to a blog post or use case on the community website with examples on how to use them.
  • Create a separate page at the end of the installation instructions dedicated to this topic.

Additional info
This issue was created after discussion with @chicken-biryani and @shubhamkarande13 about #58

@sarahhaggarty
Copy link
Contributor Author

@aornugent @HarshCasper, can we get your thoughts on the possibilities suggested please?

@aornugent
Copy link
Contributor

aornugent commented Jul 29, 2021

Thanks for the great issue - it's very clear and succinct.

Can we do both?

  1. Let's put some very brief instructions in a separate page, with a link to the Land_Sector_Datasets repo, so that it's clear they exist; then
  2. develop a section on the community website describing which datasets are available. @jenkatesmits might be able to help us write a short case study about how the datasets were compiled.

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

2 participants