Skip to content

Commit 3c1b4a7

Browse files
committed
fix typos in docs
1 parent 0b79aa1 commit 3c1b4a7

5 files changed

+13
-13
lines changed

docs/_docs/dependencies.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ The Python dependencies are defined in the following files:
6262
- `csle/simulation-system/libs/csle-attack-profiler/setup.cfg`
6363

6464
These files need to be updated whenever a Python dependency is added or removed.
65-
The dependency structure among the CSLE Python libraries is shown in Fig. 30.
65+
The dependency structure among the CSLE Python libraries is shown in Fig. 31.
6666

6767
<p align="center">
6868
<img src="./../../img/dependencies.png" width="75%">
6969
<p class="captionFig">
70-
Figure 30: Dependency graph showing the dependencies among the CSLE Python libraries;
70+
Figure 31: Dependency graph showing the dependencies among the CSLE Python libraries;
7171
an arrow from X to Y indicates that X depends on Y; dependency arrows are transitive.
7272
</p>
7373
</p>

docs/_docs/development_conventions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ what the changes are and possibly even why they were necessary.
208208
209209
We use continuous integration (CI) with GitHub Actions to build the project
210210
and run tests on every pull request submitted to CSLE.
211-
The CI pipeline used in CSLE is illustrated in Fig. 29.
211+
The CI pipeline used in CSLE is illustrated in Fig. 30.
212212
Developers make commits on a branch that is separated from the master/main branch.
213213
Once a developer has completed a bugfix or a new feature, he/she submits a pull request to GitHub.
214214
The pull request then triggers a set of automated tests and automated builds using GitHub actions.

docs/_docs/installing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The recommended way to install CSLE is to use Ansible, as described above.
99
This section describes an alternative, manual, way of installing CSLE. The
1010
manual installation can be suitable if you want to customize the installation.
1111

12-
The installation of CSLE can be divided in four main steps (see Fig. 26).
12+
The installation of CSLE can be divided in four main steps (see Fig. 27).
1313
The first step is "Installation setup", which comprises installation configuration
1414
and installation of build tools.
1515
In the second step, the metastore and the simulation system are installed.
@@ -76,7 +76,7 @@ set -gx CSLE_HOME "/path/to/csle"
7676
Listing 11: Line to add to the fish configuration file to set the `CSLE_HOME` environment variable.
7777
</p>
7878

79-
After performing the steps above, you should have the directory layout shown in Fig. 27.
79+
After performing the steps above, you should have the directory layout shown in Fig. 28.
8080

8181
<p align="center">
8282
<img src="./../../img/dir_layout.png" width="70%">

docs/_docs/operating_csle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ permalink: /docs/operating/
77

88
This section describes commands and procedures that are useful when operating CSLE.
99
The framework can be operated in two ways,
10-
either through the web interface or through the CLI (see Fig. 28).
10+
either through the web interface or through the CLI (see Fig. 29).
1111
This section focuses on the CLI, but more or less the same commands can be invoked through the web interface,
1212
which should be self-explanatory.
1313

docs/_docs/setup_pycharm.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -28,43 +28,43 @@ Listing 183: Command for cloning the source code of CSLE.
2828

2929
#### Step 3: Setup PyCharm for remote development.
3030

31-
Start PyCharm on your local machine and open the CSLE project. Next, go to "Preferences" in PyCharm (see Fig. 31).
31+
Start PyCharm on your local machine and open the CSLE project. Next, go to "Preferences" in PyCharm (see Fig. 32).
3232

3333
<p align="center">
3434
<img src="./../../img/pycharm_1.png" width="45%">
3535
<p class="captionFig">
36-
Figure 31: The preferences tab in PyCharm.
36+
Figure 32: The preferences tab in PyCharm.
3737
</p>
3838
</p>
3939

4040
Then configure an SSH interpreter for the project by selecting the Python interpreter of the server where
41-
CSLE is installed (see Figs. 32-35).
41+
CSLE is installed (see Figs. 33-36).
4242

4343
<p align="center">
4444
<img src="./../../img/pycharm_2.png" width="45%">
4545
<p class="captionFig">
46-
Figure 32: Configuration of a remote SSH Python interpreter in PyCharm (1/4).
46+
Figure 33: Configuration of a remote SSH Python interpreter in PyCharm (1/4).
4747
</p>
4848
</p>
4949

5050
<p align="center">
5151
<img src="./../../img/pycharm_3.png" width="45%">
5252
<p class="captionFig">
53-
Figure 33: Configuration of a remote SSH Python interpreter in PyCharm (2/4).
53+
Figure 34: Configuration of a remote SSH Python interpreter in PyCharm (2/4).
5454
</p>
5555
</p>
5656

5757
<p align="center">
5858
<img src="./../../img/pycharm_4.png" width="45%">
5959
<p class="captionFig">
60-
Figure 34: Configuration of a remote SSH Python interpreter in PyCharm (3/4).
60+
Figure 35: Configuration of a remote SSH Python interpreter in PyCharm (3/4).
6161
</p>
6262
</p>
6363

6464
<p align="center">
6565
<img src="./../../img/pycharm_5.png" width="45%">
6666
<p class="captionFig">
67-
Figure 35: Configuration of a remote SSH Python interpreter in PyCharm (4/4).
67+
Figure 36: Configuration of a remote SSH Python interpreter in PyCharm (4/4).
6868
</p>
6969
</p>
7070

0 commit comments

Comments
 (0)