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

Add the news for v5.0.x branch. #10084

Merged
merged 1 commit into from
Mar 31, 2022
Merged

Conversation

awlauria
Copy link
Contributor

@awlauria awlauria commented Mar 8, 2022

This is bringing back the news from 66ecc05,
which was removed with the readthedocs change.

Signed-off-by: Austen Lauria awlauria@us.ibm.com

@awlauria
Copy link
Contributor Author

awlauria commented Mar 9, 2022

bot:aws:retest

@jsquyres
Copy link
Member

These are legit CI errors:

/home/ec2-user/workspace/open-mpi.build.platforms/Platform/amazon_linux_2/src/docs/news/news-v5.0.x.rst:39: ERROR: Unexpected indentation.
/home/ec2-user/workspace/open-mpi.build.platforms/Platform/amazon_linux_2/src/docs/news/news-v5.0.x.rst:40: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/ec2-user/workspace/open-mpi.build.platforms/Platform/amazon_linux_2/src/docs/news/news-v5.0.x.rst:59: ERROR: Unexpected indentation.

@awlauria
Copy link
Contributor Author

Will fix today.

@awlauria
Copy link
Contributor Author

Should be good to go.

Copy link
Member

@jsquyres jsquyres left a comment

Choose a reason for hiding this comment

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

I gave up before reaching the bottom. Please edit this a bit. Here's some guidelines:

  1. Don't list user's email addresses. We don't need to publish those for spammers to harvest.
  2. Only list external contributors. If someone works for one of the Open MPI regular community member organizations, we don't need to list them.
  3. This file is mean to be proper english. Do not use abbreviated words (e.g., "collective ops" should be "MPI collective operations"), do not use the git commit style ("section: brief description"). Write proper english sentences with good grammar, punctuation, and capitalization.
  4. Only mention things that are visible to users. Don't bother mentioning internal implementation details that have changed and are either largely or entirely invisible to the user.
  5. Describe changes in the context of what the user will notice. E.g., don't say that coll/uct was added, say that UCX support was added for MPI collective operations when not using the UCX PML.
  6. Group similar bullets together into sub-bullets. E.g., gather all the Fortran bullets and put them under one top-level "* Fortran updates" bullet (or something like that).
    • You can/will need to significantly re-order the bullets to do this.
    • I didn't see a bullet about the all-new documentation. There should be a top-level bullet about the new docs (and the https://docs.open-mpi.org/ web site) and then group all docs-related bullets under that (there were several docs bullets about people who helped along the way).
  7. Don't list one bullet down low, and then have another bullet above it that contradicts it. Read through the entire list and make sure that this list is cohesive and self-consistent.

This is a document. It is not just a collection of independent bullets.

@awlauria awlauria force-pushed the news_v5.0.x_docs branch 2 times, most recently from 0a8a468 to d5b3ceb Compare March 30, 2022 13:54
@gpaulsen gpaulsen requested a review from jsquyres March 30, 2022 13:58
- Updated to use PMIx ``v4.2`` branch - current hash: ``1b86a35``.
- Updated to use PRRTE ``v2.1`` branch - current hash: ``91f791e``.

- New MPI-4.0 features:
Copy link
Member

@gpaulsen gpaulsen Mar 30, 2022

Choose a reason for hiding this comment

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

Before we release, we should have a disclaimer here stating that while Open MPI v5.0.0 is NOT yet MPI-4.0 compliant, we do have a number of MPI-4.0 features implemented for developers to begin to use.

I'd also recommend moving the New MPI-4.0 features down below some of our important changes from v4.1... since majority of users will have older MPI codes.

Copy link
Member

@gpaulsen gpaulsen left a comment

Choose a reason for hiding this comment

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

Lets address all of these in a post rc4 update.


- New MPI-4.0 features:

- Support for ``MPI Sesisons`` has been added.
Copy link
Member

Choose a reason for hiding this comment

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

We should also add a link to (https://github.com/open-mpi/ompi-tests-public/tree/master/sessions) where users can find our MPI Sessions test cases.

which was removed with the readthedocs change.

Signed-off-by: Austen Lauria <awlauria@us.ibm.com>
@jsquyres
Copy link
Member

bot:aws:retest

@gpaulsen gpaulsen dismissed jsquyres’s stale review March 31, 2022 15:07

We think we resolved all suggestions. We will have another pass at documentation before release.

@gpaulsen gpaulsen merged commit 7d3e895 into open-mpi:main Mar 31, 2022
@awlauria awlauria deleted the news_v5.0.x_docs branch March 31, 2022 15:10
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.

3 participants