Skip to content

Commit

Permalink
fix typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Limmen committed May 9, 2024
1 parent 0b79aa1 commit 3c1b4a7
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/_docs/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,12 @@ The Python dependencies are defined in the following files:
- `csle/simulation-system/libs/csle-attack-profiler/setup.cfg`

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

<p align="center">
<img src="./../../img/dependencies.png" width="75%">
<p class="captionFig">
Figure 30: Dependency graph showing the dependencies among the CSLE Python libraries;
Figure 31: Dependency graph showing the dependencies among the CSLE Python libraries;
an arrow from X to Y indicates that X depends on Y; dependency arrows are transitive.
</p>
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/development_conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ what the changes are and possibly even why they were necessary.
We use continuous integration (CI) with GitHub Actions to build the project
and run tests on every pull request submitted to CSLE.
The CI pipeline used in CSLE is illustrated in Fig. 29.
The CI pipeline used in CSLE is illustrated in Fig. 30.
Developers make commits on a branch that is separated from the master/main branch.
Once a developer has completed a bugfix or a new feature, he/she submits a pull request to GitHub.
The pull request then triggers a set of automated tests and automated builds using GitHub actions.
Expand Down
4 changes: 2 additions & 2 deletions docs/_docs/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The recommended way to install CSLE is to use Ansible, as described above.
This section describes an alternative, manual, way of installing CSLE. The
manual installation can be suitable if you want to customize the installation.

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

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

<p align="center">
<img src="./../../img/dir_layout.png" width="70%">
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/operating_csle.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ permalink: /docs/operating/

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

Expand Down
14 changes: 7 additions & 7 deletions docs/_docs/setup_pycharm.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,43 +28,43 @@ Listing 183: Command for cloning the source code of CSLE.

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

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

<p align="center">
<img src="./../../img/pycharm_1.png" width="45%">
<p class="captionFig">
Figure 31: The preferences tab in PyCharm.
Figure 32: The preferences tab in PyCharm.
</p>
</p>

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

<p align="center">
<img src="./../../img/pycharm_2.png" width="45%">
<p class="captionFig">
Figure 32: Configuration of a remote SSH Python interpreter in PyCharm (1/4).
Figure 33: Configuration of a remote SSH Python interpreter in PyCharm (1/4).
</p>
</p>

<p align="center">
<img src="./../../img/pycharm_3.png" width="45%">
<p class="captionFig">
Figure 33: Configuration of a remote SSH Python interpreter in PyCharm (2/4).
Figure 34: Configuration of a remote SSH Python interpreter in PyCharm (2/4).
</p>
</p>

<p align="center">
<img src="./../../img/pycharm_4.png" width="45%">
<p class="captionFig">
Figure 34: Configuration of a remote SSH Python interpreter in PyCharm (3/4).
Figure 35: Configuration of a remote SSH Python interpreter in PyCharm (3/4).
</p>
</p>

<p align="center">
<img src="./../../img/pycharm_5.png" width="45%">
<p class="captionFig">
Figure 35: Configuration of a remote SSH Python interpreter in PyCharm (4/4).
Figure 36: Configuration of a remote SSH Python interpreter in PyCharm (4/4).
</p>
</p>

Expand Down

0 comments on commit 3c1b4a7

Please sign in to comment.