moja-global / moja-global/moja_global_docs

New location for Data Sets subtopic

Open
#60 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
35
Forks
64
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/DevelopmentSetup/index.rst and locate the Data Sets subtopic. Review issue #58 and the discussion with the named contributors before choosing whether to remove the section or create a separate page. Done means the placement is agreed and the Development Setup page no longer introduces Data Sets before installation and simulation use.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.