Skip to content

Conversation

Mayankm96
Copy link
Contributor

@Mayankm96 Mayankm96 commented Sep 12, 2025

Description

A lot of content is shared between different installation guides. This MR moves them to a common "include" so that it is easier for us to maintain and modify these changes.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • 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

@github-actions github-actions bot added bug Something isn't working documentation Improvements or additions to documentation labels Sep 12, 2025
@Mayankm96
Copy link
Contributor Author

Some overlap with #3442 but I would suggest we merge that one first before this one.

Copy link
Collaborator

@jtigue-bdai jtigue-bdai left a comment

Choose a reason for hiding this comment

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

LGTM

- Highlights bind-mounted directories for live code editing and explains how to stop or remove the container
while keeping the image and artifacts.

- :doc:`cluster`
Copy link
Contributor

Choose a reason for hiding this comment

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

would it make sense to also include Automator as a section in the various deployment workflows?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm yes we need to rework this more. To me, Docker container is a nice development workflow for local installation.

The deployment should be focused on actual clusters:

  • Singularity-based
  • Cloud-based
  • Kubernetes

@kellyguo11
Copy link
Contributor

Thanks for the updates, this looks really nice!

Looks like linter check is failing though.

@Mayankm96 Mayankm96 merged commit e4d644f into isaac-sim:main Sep 18, 2025
6 of 7 checks passed
@Mayankm96 Mayankm96 deleted the fix/shared-steps branch September 18, 2025 07:25
kellyguo11 added a commit that referenced this pull request Sep 18, 2025
A lot of content is shared between different installation guides. This
MR moves them to a common "include" so that it is easier for us to
maintain and modify these changes.

- Documentation update

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [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

---------

Co-authored-by: Kelly Guo <[email protected]>
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Sep 20, 2025
# Description

A lot of content is shared between different installation guides. This
MR moves them to a common "include" so that it is easier for us to
maintain and modify these changes.

## Type of change

- Documentation update

## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [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

---------

Co-authored-by: Kelly Guo <[email protected]>
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Sep 29, 2025
# Description

A lot of content is shared between different installation guides. This
MR moves them to a common "include" so that it is easier for us to
maintain and modify these changes.

## Type of change

- Documentation update

## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [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

---------

Co-authored-by: Kelly Guo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants