Updates the content and creates a landing page

This (huge) commit updates the content of pages after a manual
verification, creates a landing page, adds Prettier for automatic
formatting in Visual Studio Code, adds SEO tags, and much more.

Signed-off-by: George-Andrei Iosif <[email protected]>

Author: iosifache

.gitignore

@@ -1,20 +1,7 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
+# Docusaurus
 .docusaurus
 .cache-loader
 
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+# Node.js
+node_modules
+build

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none"
+}

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "usernamehw.errorlens",
+    "yzhang.markdown-all-in-one",
+    "shd101wyy.markdown-preview-enhanced",
+    "bierner.markdown-preview-github-styles"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "editor.tabSize": 2,
+  "editor.wordWrap": "on",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "prettier.enable": true,
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": null
+  }
+}

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright © 2022 MutableSecurity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,9 +1,13 @@
-# `mutablesecurity.io`
+<div align="center">
+    <img src="others/cover.webp" width="600px" alt="Cover">
+    <br/><br/>
+    <img src="https://img.shields.io/badge/backend-Docusaurus%202-lightgray?color=lightgray&logoColor=white&label=backend&logo=react&style=flat-square" alt="Backend">
+    <img src="https://img.shields.io/github/license/mutablesecurity/mutablesecurity?color=lightgray&label=license&logo=opensourceinitiative&style=flat-square&logoColor=white" alt="License">
+    <br/>
+</div>
 
-## Cheatsheet
+---
 
-- `npx docusaurus start` for starting the development server
+# Description
 
-## Resources
-
-- [Docusaurus 2](https://docusaurus.io/), a modern static website generator
+`mutablesecurity.io` is a Docusaurus-backed website providing MutableSecurity a landing page, usage and contribution documentations, and a blog.

babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')]
 };

blog/2022-07-31-hello.md

@@ -0,0 +1,10 @@
+---
+slug: welcome
+title: Welcome to our blog!
+authors: mutablesecurity
+tags: [welcome]
+---
+
+The MutableSecurity team will publish high-quality content for IT professionals on topics such as the use of cybersecurity solutions, DevSecOps techniques, and best practices for technologies used in the development of MutableSecurity.
+
+Follow us on [LinkedIn](https://linkedin.com/company/mutablesecurity) and [Twitter](https://twitter.com/mutablesecurity) to receive updates about new content!

blog/2022-08-08-welcome.md

@@ -1,5 +1,4 @@
-iosifache:
-  name: George-Andrei Iosif
-  title: Founder Member and Core Developer
-  url: https://github.com/iosifache
-  image_url: https://github.com/iosifache.png
+mutablesecurity:
+  name: MutableSecurity
+  url: https://github.com/MutableSecurity
+  image_url: https://github.com/MutableSecurity.png

blog/authors.yml

@@ -8,7 +8,7 @@ This introductory reading is intended to serve as a first step toward using or c
 
 ## Information
 
-- [MutableSecurity](MutableSecurity.md)
-- [Orchestration Architecture](Orchestration%20Architecture.md)
-- [Cybersecurity Solutions](Cybersecurity%20Solutions.md)
-- [Indexes](Indexes.md)
+- [MutableSecurity](mutablesecurity.md)
+- [Orchestration Architecture](orchestration-architecture.md)
+- [Cybersecurity Solutions](cybersecurity-solutions.md)
+- [Indexes](indexes.md)

docs/_basics/README.md

@@ -4,13 +4,13 @@ sidebar_position: 4
 
 # Cybersecurity Solutions
 
-After the connection with the target host(s) was established, the purpose of MutableSecurity is now to execute operations on each target host. An **operation** is a manipulation of a cybersecurity solution (hereafter referenced as **solution**) that is installed or needs to be installed. Could vary from effective installation to testing. By executing the operations in an established order, the solution is managed through its entire **lifecycle**.
+After the connection with the target host(s) was established, the purpose of MutableSecurity is now to execute operations on each target host. An **operation** is used to manipulate a cybersecurity solution (hereafter referenced as **solution**) that is installed or needs to be installed. The process could vary from effective installation all the way to testing. By executing the operations in an established order, the solution is managed through its entire **lifecycle**.
 
 The part of MutableSecurity's codebase that deals with automating a specific solution is referenced as **module**.
 
 ## Automation Logic
 
-A great majority of automation's logic inside a module is divided in buckets:
+A great majority of automation's logic inside a module is divided in bundles:
 - **Actions**: An action is an on-demand behavior that can be performed by the security solution. For example, an on-demand scan of a file, with an antivirus program, is considered an action.
 - **Information**: An information is a fact/detail about the solution. We name an information either **configuration**, if it is writable, or **metric**, if it is read-only. A valid sequence of ports used in a port-knock server or the number of alerts generated in the current day by a network intrusion detection system are both categorized in MutableSecurity as information. More precisely, the first is a configuration and the second a metric.
 - **Logs**: Logging messages are generated by the solution, being relevant to understand its functioning. For instance, a web intrusion detection system may log its alerts in a file, besides reporting them in a web-based administration platform.
@@ -23,5 +23,5 @@ Beside the effective automation code, each module contains more information desc
 - **Full name**: It is the name under which the solution is presented in the cybersecurity solutions market.
 - **Description**: Text offering miscellaneous information about the solution, such as vendors and security benefits 
 - **References**: Useful links redirecting to presentation pages, documentations, etc.
-- **Maturity level**: This level indicates in which stage the module's implementation resides. It can vary from under development, when the maintainers are working on it, to production, when the implementation is tested and pushed into the official package. The possible values are presented in the [index](Indexes.md#maturity-levels).
-- **Categories**: The solution is introduced in consecrated security solutions categories (for example, firewalls and antivirus programs). The valid values are presented in the [index](Indexes.md#solutions-categories).
+- **Maturity level**: This level indicates in which stage the module's implementation resides. It can vary from under development, when the maintainers are working on it, to production, when the implementation is tested and pushed into the official package. The possible values are presented in the [index](indexes.md#maturity-levels).
+- **Categories**: The solution is introduced in consecrated security solutions categories (for example, firewalls and antivirus programs). The valid values are presented in the [index](indexes.md#solutions-categories).

docs/_basics/Cybersecurity Solutions.md renamed to docs/_basics/cybersecurity-solutions.md

@@ -7,7 +7,7 @@ sidebar_position: 5
 ## Maturity Levels
 
 | Level               | Description                                                                                   |
-|---------------------|-----------------------------------------------------------------------------------------------|
+| ------------------- | --------------------------------------------------------------------------------------------- |
 | `PRODUCTION`        | The solution is developed, tested and integrated in the production package.                   |
 | `REFACTORING`       | The solution was integrated in production, but now suffers changes.                           |
 | `UNDER_DEVELOPMENT` | The solution development is started and in progress.                                          |
@@ -16,7 +16,7 @@ sidebar_position: 5
 ## Solutions Categories
 
 | Category         | Description                             |
-|------------------|-----------------------------------------|
+| ---------------- | --------------------------------------- |
 | `WEB_IDS`        | Web Intrusion Detection System          |
 | `NETWORK_IDPS`   | Network Detection and Prevention System |
 | `WEB_ENCRYPTION` | Encryption for Web Applications         |
@@ -25,18 +25,18 @@ sidebar_position: 5
 ## Test Types
 
 | Type          | Verified Aspect                                                            | Example                                                |
-|---------------|----------------------------------------------------------------------------|--------------------------------------------------------|
-| `REQUIREMENT` | The system is compatible.                                                  | The operating system is Ubuntu.                        | 
+| ------------- | -------------------------------------------------------------------------- | ------------------------------------------------------ |
+| `REQUIREMENT` | The system is compatible.                                                  | The operating system is Ubuntu.                        |
 | `PRESENCE`    | The solution is installed on the machine.                                  | Suricata's executable is present.                      |
 | `OPERATIONAL` | The solution is running (with or without achieving its security purposes). | Suricata's process is running.                         |
 | `SECURITY`    | The solution achieves its security-related goals.                          | The firewall detects artificial malicious traffic.     |
-| `INTEGRATION` | The solution integrates with other components of the infrastructure.       | The threat hunting agent communicate with its manager. |  
+| `INTEGRATION` | The solution integrates with other components of the infrastructure.       | The threat hunting agent communicate with its manager. |
 
 ## Information Properties
 
 | Property                        | Description                                                                                                                                                             | Another Required Properties  | Example                                                       |
-|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------------------------------------|
-| `CONFIGURATION`                 | Information on which depends the functioning of the solution                                                                                                            |                              | Quarantine folder for an antivirus                            |
+| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------------------------------------------------------------- |
+| `CONFIGURATION`                 | Information required to make a solution operable                                                                                                                        |                              | Quarantine folder for an antivirus                            |
 | `METRIC`                        | Read-only information that is exposed by the solution, describing its functioning                                                                                       | `READ_ONLY`                  | Number of blocked malware by an antivirus                     |
 | `MANDATORY`                     | Required to be set during the whole functioning of the solution                                                                                                         | `CONFIGURATION`              | Email where an XDR sends its critical alerts                  |
 | `OPTIONAL`                      | Optional to set                                                                                                                                                         | `CONFIGURATION`              | Additional threat hunting sources for an IDS                  |

docs/_basics/Indexes.md renamed to docs/_basics/indexes.md

@@ -6,6 +6,6 @@ sidebar_position: 3
 
 **Target hosts** are the computers where the deployment or management actions will take place.
 
-At the moment, two **deployment styles** are used to interact with target hosts:
-- **Local deployment**: The actions are carried out on the same host from which MutableSecurity was downloaded and executed.
+At the moment, two **deployment method** are used to interact with target hosts:
+- **Local deployment**: The actions are carried out on the same host from where MutableSecurity was downloaded and executed.
 - **Remote deployment**: MutableSecurity securely connects to a single remote host or a list of remote hosts with whom it can communicate over the network. The computer hosting MutableSecurity is referred to as the **orchestration host** in this scenario. Password-based or key-based SSH authentication is used.

docs/_basics/MutableSecurity.md renamed to docs/_basics/mutablesecurity.md

@@ -6,19 +6,20 @@ sidebar_position: 2
 
 Thank you for taking the time to contribute to this project 🎊!
 
-Please consider reading the [basics guide](./developers/basics/) first. It covers the introductory concepts that will help you understand the detailed explanations covered in the guides above.
+Please consider reading the [basics guide](./basics/) first. It covers the introductory concepts that will help you understand the detailed explanations covered in the guides below.
 
 We've created pages with information and guides with effective steps to help you through the contribution process. If you believe there are any missing ones, create an issue and the core team will create a draft to be discussed with the entire community.
 
 ## Information
 
-- [Project Structure](Project%20Structure.md)
-- [Development Environment](Development%20Environment.md)
-- [Module Architecture](Module%20Architecture.md)
+- [Project Structure](project-structure.md))
+- [Development Environment](development-environment.md)
+- [Module Architecture](module-architecture.md)
 
 ## Guides
 
-- [Configuring the Development Environment](Configuring%20the%20Development%20Environment.md)
-- [Using Git and GitHub to Contribute](Using%20Git%20and%20GitHub%20to%20Contribute.md)
-- [Integrating a New Solution](Integrating%20a%20New%20Solution.md)
-- [Publishing a New Release](Publishing%20a%20New%20Release.md)
+- [Configuring the Development Environment](configuring-the-development-environment.md)
+- [Using Git and GitHub to Contribute](using-git-and-github-to-contribute.md)
+- [Integrating a New Solution](integrating-a-new-solution.md)
+- [Publishing a New Release](publishing-a-new-release.md)
+- [Setting Up the Documentation Locally](setting-up-the-documentation-locally.md)