equinor / equinor/ert

Improve doc for INSTALL_JOB

Open
#8,693 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
161
Forks
140
Avg merge
2d 1h
Merged PRs (30d)
138

Description

https://github.com/equinor/ert/blob/d8b17e4c7d1211cea135341501856028b77cccce/docs/reference/configuration/keywords.rst?plain=1#L421-L446

* Replace `Lomeland` with a more relevant example
* Don't claim it is easy
* Add a clickable link to the doc for the format of the "job" (fmstep) file

Contributor guide

Open the contributing guide

Research direction

Open docs/reference/configuration/keywords.rst at lines 421-446 and read the INSTALL_JOB section. Replace the Lomeland example, remove the claim that it is easy, and add a clickable link to the documentation for the fmstep job-file format; the section is done when all three requested documentation changes are present.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.