Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add a page on starting Flux #5477

Merged
merged 2 commits into from
Oct 1, 2023
Merged

Conversation

garlick
Copy link
Member

@garlick garlick commented Sep 29, 2023

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.

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.
@chu11
Copy link
Member

chu11 commented Sep 29, 2023

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

@garlick
Copy link
Member Author

garlick commented Sep 30, 2023

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.

doc/guide/start.rst Show resolved Hide resolved
doc/guide/start.rst Show resolved Hide resolved
doc/guide/start.rst Outdated Show resolved Hide resolved
doc/guide/start.rst Outdated Show resolved Hide resolved
doc/guide/start.rst Outdated Show resolved Hide resolved
doc/guide/start.rst Show resolved Hide resolved
doc/guide/start.rst Outdated Show resolved Hide resolved
Problem: flux-core docs does not describe the various ways
to start a flux instance

Add a new page.
@garlick
Copy link
Member Author

garlick commented Sep 30, 2023

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 mpirun for whatever MPI they are using, so a more appropriate section would be about how to start flux with the different mpirun variants. I already have the one from mpich (hydra). For now, I deleted the LSF section and we can leave the specialized jsrun instructions that apply only to LLNL and oak ridge to the coral document we already have.

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
Copy link

codecov bot commented Oct 1, 2023

Codecov Report

Merging #5477 (03d7a16) into master (544f916) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            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     

see 12 files with indirect coverage changes

Copy link
Member

@chu11 chu11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes LGTM

@garlick
Copy link
Member Author

garlick commented Oct 1, 2023

Thanks @chu11!

@mergify mergify bot merged commit 23e7f83 into flux-framework:master Oct 1, 2023
@garlick garlick deleted the starting_doc branch October 1, 2023 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants