From 3c1b4a7c199bcddbaa427fd98f9fc5af11f2edb0 Mon Sep 17 00:00:00 2001 From: Limmen Date: Thu, 9 May 2024 13:00:12 +0200 Subject: [PATCH] fix typos in docs --- docs/_docs/dependencies.md | 4 ++-- docs/_docs/development_conventions.md | 2 +- docs/_docs/installing.md | 4 ++-- docs/_docs/operating_csle.md | 2 +- docs/_docs/setup_pycharm.md | 14 +++++++------- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/_docs/dependencies.md b/docs/_docs/dependencies.md index 83310f1d6..26e7c5c4b 100644 --- a/docs/_docs/dependencies.md +++ b/docs/_docs/dependencies.md @@ -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.

-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.

diff --git a/docs/_docs/development_conventions.md b/docs/_docs/development_conventions.md index 7a624f1db..c20a82d4b 100644 --- a/docs/_docs/development_conventions.md +++ b/docs/_docs/development_conventions.md @@ -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. diff --git a/docs/_docs/installing.md b/docs/_docs/installing.md index 8298431ce..030b58a6a 100644 --- a/docs/_docs/installing.md +++ b/docs/_docs/installing.md @@ -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. @@ -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.

-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.

diff --git a/docs/_docs/operating_csle.md b/docs/_docs/operating_csle.md index 0ddcf9bbd..973541d5a 100644 --- a/docs/_docs/operating_csle.md +++ b/docs/_docs/operating_csle.md @@ -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. diff --git a/docs/_docs/setup_pycharm.md b/docs/_docs/setup_pycharm.md index 3ca8ed148..4d5cf61a3 100644 --- a/docs/_docs/setup_pycharm.md +++ b/docs/_docs/setup_pycharm.md @@ -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).

-Figure 31: The preferences tab in PyCharm. +Figure 32: The preferences tab in PyCharm.

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).

-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).

-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).

-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).

-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).