Refactor the fre make readme and move quickstart#792
Refactor the fre make readme and move quickstart#792singhd789 wants to merge 19 commits intoNOAA-GFDL:mainfrom
Conversation
singhd789
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #792 +/- ##
=======================================
Coverage 84.12% 84.12%
=======================================
Files 71 71
Lines 4944 4944
=======================================
Hits 4159 4159
Misses 785 785
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
… into update-fremake-readme
|
Note: I thought there was something I wanted to update or change here but I can't remember what it was.... |
ilaflott
left a comment
ilaflott
left a comment
There was a problem hiding this comment.
I'm not entirely clear on the quickstart v. guide contrast here.
Usually a guide is more detailed compared to a quickstart, which glosses over things to just get you started.
I think I could add more the the guide to make it more comprehensive. The quickstart is mainly supposed to be instructions you could almost just copy and paste to follow along. Good point, I'll try to add to the guide for more detail |
fre/make/README.md
Outdated
|
|
||
| Use fre make subtools to checkout code, create a Makefile, and build a container: | ||
| ### Container Build: | ||
| In order for the container to build successfully, the parallel checkout feature is disabled. |
There was a problem hiding this comment.
hmm, maybe parallel checkout example should be given above for the bare-metal build?
There was a problem hiding this comment.
For the bare-metal build, the parallel checkout is the default behavior. Do you think users would want to see a non-parallel checkout example for the bare-metal build?
(I added a note that it is the default behavior)
fre/make/README.md
Outdated
| ``` | ||
|
|
||
| Use `fre make all` to do the job of all 3 subtools in one step: | ||
| ### Run all of fremake: |
There was a problem hiding this comment.
"blackbox" fre make? maybe this should be at the top
There was a problem hiding this comment.
made it "all-in-one"? Is this better? 😅
| fre make all -y fre/make/tests/null_example/null_model.yaml -p hpcme.2023 -t prod --execute | ||
| ``` | ||
|
|
||
| ## Subtools |
There was a problem hiding this comment.
wondering if this section is needed...
There was a problem hiding this comment.
Oook, maybe you're onto something here. I forgot (and just re-found) that a [tools].rst files exists in the docs as well. I suppose we want to get rid of duplication.
… into update-fremake-readme
3 participants
Describe your changes
Issue ticket number and link (if applicable)
Checklist before requesting a review
Note: If you are a code maintainer updating the tag or releasing a new fre-cli version, please use the
release_procedure.mdtemplate. To quickly use this template, open a new pull request, choose your branch, and add?template=release_procedure.mdto the end of the url.