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

Improves docker X11 forwarding documentation #685

Merged
merged 3 commits into from
Jul 26, 2024

Conversation

j3soon
Copy link
Contributor

@j3soon j3soon commented Jul 15, 2024

Description

Clarify X11 forwarding configs in docs and warning messages.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

Co-authored-by: David Hoeller <dhoeller@nvidia.com>
Signed-off-by: Johnson Sun <20457146+j3soon@users.noreply.github.com>
@Dhoeller19 Dhoeller19 changed the title Clarify X11 forwarding configs Improves docker X11 forwarding documentation Jul 25, 2024
Copy link
Collaborator

@hhansen-bdai hhansen-bdai left a comment

Choose a reason for hiding this comment

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

Looks great, thanks!

Copy link
Collaborator

@Dhoeller19 Dhoeller19 left a comment

Choose a reason for hiding this comment

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

Thanks @j3soon

@Dhoeller19 Dhoeller19 merged commit ab7cdb8 into isaac-sim:main Jul 26, 2024
1 of 2 checks passed
@j3soon j3soon deleted the docs/x11-forwarding branch July 26, 2024 07:59
@Mayankm96
Copy link
Contributor

Quick note: Is there a reason we have this variable as __ISAACLAB_X11_FORWARDING_ENABLED? This would have meant it is a private quantity that users should not need to set. Can we fix this?

iamdrfly pushed a commit to iamdrfly/IsaacLab that referenced this pull request Nov 21, 2024
# Description

Clarify X11 forwarding configs in docs and warning messages.

## Type of change

- Bug fix (non-breaking change which fixes an issue)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants