doc: add a page on starting Flux - #5477
Conversation
Problem: documentation in the top level doc directory is not going to scale out very well. Create a 'guide' subdirectory and move the build and support pages there. Change the spellcheck script so that it spell *.rst in that directory.
|
began reading this, I began thinking maybe this belongs more in flux-docs? It might be a good "lead-in" document before some of the more specific tutorials, such as my forever WIP flux-framework/flux-docs#225 |
|
Admittedly this section is useful stuff for flux framework generally but my goal (as noted in #5470) was to build up some flux-core specific documentation to complement the manual pages. |
dfe73c8 to
fd2bf90
Compare
Problem: flux-core docs does not describe the various ways to start a flux instance Add a new page.
fd2bf90 to
03d7a16
Compare
|
I made a couple of changes to the last sections. I dropped the LSF section since it appears that LSF users normally launch MPI programs with the I changed the "Starting with systemd" section to a more detailed and generalized "Starting with Static Configuration" section and mentioned the operator and system instance in that section with external references. |
Codecov Report
@@ Coverage Diff @@
## master #5477 +/- ##
==========================================
- Coverage 83.65% 83.62% -0.04%
==========================================
Files 483 483
Lines 81427 81427
==========================================
- Hits 68120 68090 -30
- Misses 13307 13337 +30 |
|
Thanks @chu11! |
This adds a readthedocs page containing several ways to start a flux instance, with more explanation that we've given in our other higher level docs.