Make documentation updates#916
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #916 +/- ##
==========================================
+ Coverage 82.03% 82.09% +0.05%
==========================================
Files 67 67
Lines 3736 3736
==========================================
+ Hits 3065 3067 +2
+ Misses 671 669 -2
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 1 file with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
laurenchilutti
changed the title
singhd789
left a comment
singhd789
left a comment
There was a problem hiding this comment.
Thanks for this update. I was working on updating some of these things in that readme refactor I had going but may have missed some myself. One thing to note - I believe the -npc option may just be the default for container builds now, so it may not even really be needed in the guides/quickstarts.
| # Create checkout script | ||
| fre make checkout-script -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] | ||
| # Create checkout script (turning off parallel checkout) | ||
| fre make checkout-script -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] -npc |
There was a problem hiding this comment.
I don't think -npc is actually needed anymore (it's the default behavior for containers now)
| fre make all -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] --execute | ||
| # Run all of fremake: create and run checkout script, makefile, dockerfile, container | ||
| # creation script, and build the model container | ||
| fre make all -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] -npc --execute |
There was a problem hiding this comment.
similar -npc comment as above
| In order for the container to build successfully, the parallel checkout feature is disabled using the -npc option. | ||
|
|
||
| .. code-block:: | ||
| .. code-block:: bash | ||
|
|
||
| # Create checkout script | ||
| fre make checkout-script -y null_model.yaml -p hpcme.2023 -t prod | ||
| # Create checkout script | ||
| fre make checkout-script -y null_model.yaml -p hpcme.2023 -t prod -npc |
| # Create Makefile | ||
| fre make makefile -y null_model.yaml -p hpcme.2023 -t prod | ||
| # Create Makefile | ||
| fre make makefile -y null_model.yaml -p hpcme.2023 -t prod |
There was a problem hiding this comment.
Ooof, this was a good reminder - these platforms may need to be severely updated. I'm not even sure we should be using some of these anymore 😅
There was a problem hiding this comment.
Thank you for this consistency fix. I'm going to suggest we just include --execute and not -e because there are some other fre tools that use -e for experiment name.
2 participants
Describe your changes
This changes fremake documentation in the docs/ directory (rst files) and in the fremake.py cli interface defining file.
Background info:
I noticed that the
--execute/-e argumentsinfremake.pyvaried by subtool:fre make allsupported -e and --executefre make checkout-scriptsupported only --executefre make compile-scriptsupported only --executefre make dockerfilesupported only --executeAnd I also noticed that the documentation in the docs/ directory stated that:
fre make alldidn't mention execute at allfre make checkout-scriptsupported -e and --executefre make compile-scriptsupported -e and --executefre make dockerfiledidn't mention execute at allAs a result:
I made changes to
fremake.pyto have all subtools suport--ecxecuteand-eI then used AI (Gemini 3.5 Flash in the web browser) to update
docs/tools/make.rstanddocs/usage/guides/fre_make_guide.rstbased onfremake.pyI made changes to what AI produced.
Issue ticket number and link (if applicable)
N/A
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.