Skip to content

Commit fe509d9

Browse files
authored
docs: minor edits (#694)
1 parent f7a4eb6 commit fe509d9

File tree

4 files changed

+13
-18
lines changed

4 files changed

+13
-18
lines changed

doc/source/getting_started/docker.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,12 @@ Running Windows Docker containers
2323
To run the Windows Docker container for the Geometry service, ensure that you follow
2424
these steps when installing Docker:
2525

26-
#. Install Docker Desktop 4.13.1. To download this version, use the Windows download link
27-
in the `4.13.1 <https://docs.docker.com/desktop/release-notes/#4131>`_ section of the
28-
Docker release notes. Newer Docker Desktop versions present problems when running
29-
Windows Docker containers.
26+
#. Install `Docker Desktop <https://docs.docker.com/desktop/install/windows-install/>`.
3027

3128
#. When prompted for **Use WSL2 instead of Hyper-V (recommended)**, clear this checkbox.
3229

3330
#. Once the installation finishes, start Docker Desktop.
3431

35-
#. Go to **Settings > Software updates**, clear the **Automatically check for updates** checkbox, and
36-
click **Apply & restart**.
37-
3832
#. On the Windows taskbar, go to the **Show hidden icons** section, right-click in the Docker Desktop app, and
3933
select **Switch to Windows containers**.
4034

@@ -50,7 +44,7 @@ There are two options for users to install the PyAnsys Geometry image:
5044

5145
.. _ref_docker_ghcr:
5246

53-
GitHub Container registry
47+
GitHub Container Registry
5448
^^^^^^^^^^^^^^^^^^^^^^^^^
5549

5650
.. note::

doc/source/getting_started/existing_client_session.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Note that your local port number might differ from the one shown in the precedin
2222

2323
Verify the connection
2424
---------------------
25-
If you want to verify that the connection is successful, check the status of the client
25+
If you want to verify that the connection is successful, request the status of the client
2626
connection inside your ``Modeler`` object:
2727

2828
.. code:: pycon

doc/styles/Vocab/ANSYS/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ geometry
1010
Geometry service
1111
Geometry models
1212
GitHub
13+
GitHub Container Registry
1314
namespace
1415
Polydata
1516
PROTO

docker/README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ Create your own Geometry service docker container
66
The Geometry service Docker containers can be easily built by following
77
these steps.
88

9-
Inside this folder, the instructions (i.e. ``Dockerfile.*`` files) for
10-
building the Geometry service Docker containers are made available. We have
11-
two ``Dockerfile`` files:
9+
Inside the repository's ``docker`` folder, the instructions
10+
(i.e. ``Dockerfile.*`` files) for building the Geometry service Docker
11+
containers are made available. There are two ``Dockerfile`` files:
1212

1313
* ``Dockerfile.linux``: this file builds the Linux-based Docker image.
1414
* ``Dockerfile.windows``: this file builds the Windows-based Docker image.
1515

1616
Depending on the characteristics of the Docker engine installed in your
17-
machine, you will have to build one or the other. For example:
17+
machine, either one or the other has to be built. For example:
1818

19-
* If you are running on a Linux-based machine, you will need to build the
19+
* If you are running on a Linux-based machine, build the
2020
``Dockerfile.linux`` image.
21-
* If you are running on a Windows-based machine with Docker CE, you will
22-
need to build the ``Dockerfile.windows`` image.
21+
* If you are running on a Windows-based machine with Docker CE,
22+
build the ``Dockerfile.windows`` image.
2323
* If you are running on a Windows-based machine and you have ``WSL``,
2424
bear in mind that you can also run Linux containers.
2525

@@ -31,7 +31,7 @@ Prerequisites
3131
`official Docker site <https://www.docker.com>`_.
3232

3333
* Download the latest release artifacts for the Windows or Linux
34-
Docker container. You can do this as follows:
34+
Docker container. This is done as follows:
3535

3636
* Latest Linux artifacts: `linux-binaries.zip <https://github.com/ansys/pyansys-geometry/releases/latest/download/linux-binaries.zip>`_
3737
* Latest Windows artifacts: `windows-binaries.zip <https://github.com/ansys/pyansys-geometry/releases/latest/download/windows-binaries.zip>`_
@@ -50,7 +50,7 @@ In order to build your images, follow the next instructions:
5050
5151
docker build -t ghcr.io/ansys/geometry:<DOCKER_IMAGE_TAG> -f <DOCKERFILE_NAME> .
5252
53-
Bear in mind that you will need to substitute the following entries in the previous command,
53+
Bear in mind that you need to substitute the following entries in the previous command,
5454
determined by whether you want to build the Linux-based or the Windows-based Docker image:
5555

5656
* ``<DOCKERFILE_NAME>``: this will be either ``Dockerfile.linux`` or ``Dockerfile.windows``

0 commit comments

Comments
 (0)