Skip to content

Conversation

@chris-janidlo
Copy link
Contributor

@chris-janidlo chris-janidlo commented Dec 17, 2025

Description

Refactors MPI documentation, with a focus on adding a tutorial for configuring and submitting MPI tasks. Existing MPI documentation is moved around but is otherwise mostly unchanged, save some formatting/syntax fixes.

[SC-41206]

Type of change

  • Documentation update

@chris-janidlo chris-janidlo added the no-news-is-good-news This change does not require a news file label Dec 17, 2025
@chris-janidlo chris-janidlo force-pushed the mpi-documentation-sc-41206 branch from d689f60 to 33f5bc4 Compare December 19, 2025 19:49
@chris-janidlo chris-janidlo marked this pull request as ready for review December 19, 2025 19:49
yadudoc
yadudoc previously approved these changes Jan 2, 2026
Copy link
Collaborator

@yadudoc yadudoc left a comment

Choose a reason for hiding this comment

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

Looks good to me. I've added some minor notes.

Moves MPI reference documentation to the appropriate places - the
endpoint page for configuration, and the SDK user guide for MPIFunctions
- and adds a new tutorial that covers both topics.
Copy link
Contributor

@khk-globus khk-globus left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Comment on lines +127 to +132
.. code-block:: console
$ globus-compute-endpoint start my-ep
Take note of the endpoint ID emitted to the console; we will use it later in the
tutorial.
Copy link
Contributor

Choose a reason for hiding this comment

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

In addition to your "Take note of ...", you might consider also adding <NOTE THIS ID HERE> text:

   $ globus-compute-endpoint start my-ep
        >>> Endpoint ID: <NOTE THIS ID HERE> <<<

Not mandatory, just a thought. Your call.

@chris-janidlo chris-janidlo merged commit f39f010 into main Jan 5, 2026
19 of 21 checks passed
@chris-janidlo chris-janidlo deleted the mpi-documentation-sc-41206 branch January 5, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-news-is-good-news This change does not require a news file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants