Skip to content

Commit 97cf1f1

Browse files
authored
Fixes quotes in the docker documentation (#648)
# Description There were minor quote issues in the docker container instructions. This MR fixes those. ## Type of change - This change requires a documentation update ## Checklist - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] 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 - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there
1 parent 190fa85 commit 97cf1f1

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

CONTRIBUTORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Guidelines for modifications:
5353
* Shafeef Omar
5454
* Vladimir Fokow
5555
* Zhengyu Zhang
56+
* Ziqi Fan
5657

5758
## Acknowledgements
5859

docs/source/deployment/docker.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -156,18 +156,18 @@ Understanding the mounted volumes
156156
The ``docker-compose.yaml`` file creates several named volumes that are mounted to the container.
157157
These are summarized below:
158158

159-
* ``isaac-cache-kit``: This volume is used to store cached Kit resources (`/isaac-sim/kit/cache` in container)
160-
* ``isaac-cache-ov``: This volume is used to store cached OV resources (`/root/.cache/ov` in container)
161-
* ``isaac-cache-pip``: This volume is used to store cached pip resources (`/root/.cache/pip`` in container)
162-
* ``isaac-cache-gl``: This volume is used to store cached GLCache resources (`/root/.cache/nvidia/GLCache` in container)
163-
* ``isaac-cache-compute``: This volume is used to store cached compute resources (`/root/.nv/ComputeCache` in container)
164-
* ``isaac-logs``: This volume is used to store logs generated by Omniverse. (`/root/.nvidia-omniverse/logs` in container)
165-
* ``isaac-carb-logs``: This volume is used to store logs generated by carb. (`/isaac-sim/kit/logs/Kit/Isaac-Sim` in container)
166-
* ``isaac-data``: This volume is used to store data generated by Omniverse. (`/root/.local/share/ov/data` in container)
167-
* ``isaac-docs``: This volume is used to store documents generated by Omniverse. (`/root/Documents` in container)
168-
* ``isaac-lab-docs``: This volume is used to store documentation of Isaac Lab when built inside the container. (`/workspace/isaaclab/docs/_build` in container)
169-
* ``isaac-lab-logs``: This volume is used to store logs generated by Isaac Lab workflows when run inside the container. (`/workspace/isaaclab/logs` in container)
170-
* ``isaac-lab-data``: This volume is used to store whatever data users may want to preserve between container runs. (`/workspace/isaaclab/data_storage` in container)
159+
* ``isaac-cache-kit``: This volume is used to store cached Kit resources (``/isaac-sim/kit/cache`` in container)
160+
* ``isaac-cache-ov``: This volume is used to store cached OV resources (``/root/.cache/ov`` in container)
161+
* ``isaac-cache-pip``: This volume is used to store cached pip resources (``/root/.cache/pip`` in container)
162+
* ``isaac-cache-gl``: This volume is used to store cached GLCache resources (``/root/.cache/nvidia/GLCache`` in container)
163+
* ``isaac-cache-compute``: This volume is used to store cached compute resources (``/root/.nv/ComputeCache`` in container)
164+
* ``isaac-logs``: This volume is used to store logs generated by Omniverse. (``/root/.nvidia-omniverse/logs`` in container)
165+
* ``isaac-carb-logs``: This volume is used to store logs generated by carb. (``/isaac-sim/kit/logs/Kit/Isaac-Sim`` in container)
166+
* ``isaac-data``: This volume is used to store data generated by Omniverse. (``/root/.local/share/ov/data`` in container)
167+
* ``isaac-docs``: This volume is used to store documents generated by Omniverse. (``/root/Documents`` in container)
168+
* ``isaac-lab-docs``: This volume is used to store documentation of Isaac Lab when built inside the container. (``/workspace/isaaclab/docs/_build`` in container)
169+
* ``isaac-lab-logs``: This volume is used to store logs generated by Isaac Lab workflows when run inside the container. (``/workspace/isaaclab/logs`` in container)
170+
* ``isaac-lab-data``: This volume is used to store whatever data users may want to preserve between container runs. (``/workspace/isaaclab/data_storage`` in container)
171171

172172
To view the contents of these volumes, you can use the following command:
173173

docs/source/deployment/run_docker_example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ the build process when we next run ``./container.sh start``, we may enter the fo
131131
132132
docker image rm isaaclab
133133
134-
A subsequent run of ``docker image ls``` will show that the image tagged **isaaclab** is now gone. We can repeat the process for the
134+
A subsequent run of ``docker image ls`` will show that the image tagged **isaaclab** is now gone. We can repeat the process for the
135135
underlying NVIDIA container if we wish to free up more space. If a more powerful method of freeing resources from Docker is desired,
136136
please consult the documentation for the `docker prune`_ commands.
137137

0 commit comments

Comments
 (0)