Skip to content

cherry pick doc fix #3238 from main to release2.5 #3240

New issue

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

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

Already on GitHub? # to your account

Merged
merged 4 commits into from
Oct 16, 2024

Conversation

lanluo-nvidia
Copy link
Collaborator

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant and/or add your own.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project (You can use the linters)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas and hacks
  • I have made corresponding changes to the documentation
  • I have added tests to verify my fix or my feature
  • New and existing unit tests pass locally with my changes
  • I have added the relevant labels to my PR in so that relevant reviewers are notified

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 15, 2024
@lanluo-nvidia
Copy link
Collaborator Author

@peri044 I have found if I only cherry pick #3238 the doc is not correct.
I have to also cherry pick #3110 since some of the doc change here is only in main, not in release/2.5
Is it ok that I also cherry pick #3110 into release/2.5 branch.

@peri044
Copy link
Collaborator

peri044 commented Oct 16, 2024

@peri044 I have found if I only cherry pick #3238 the doc is not correct. I have to also cherry pick #3110 since some of the doc change here is only in main, not in release/2.5 Is it ok that I also cherry pick #3110 into release/2.5 branch.

I have added new commit which has the necessary doc changes for 2.5. We should not cherry pick 3110 since we are planning to release it as a part of 2.6.

Copy link
Collaborator

@peri044 peri044 left a comment

Choose a reason for hiding this comment

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

LGTM

@peri044 peri044 merged commit f2e1e6c into release/2.5 Oct 16, 2024
10 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
cla signed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants