Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add python and pip installation templates #7298

Merged
merged 6 commits into from May 15, 2024

Conversation

GGP1
Copy link
Member

@GGP1 GGP1 commented May 9, 2024

Description

Adds the /_templates/cloud/python_installation.rst and /_templates/cloud/pip_installation.rst templates to avoid repeating the cloud modules dependencies installation requirements sections. It also includes some changes to be consistent with the spelling across the guides.

Checks

Docs building

  • Compiles without warnings.
Compilation
Running Sphinx v7.0.1
loading translations [en-US]... not available for built-in messages
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] cloud-security/amazon/services/prerequisites/dependencies
Copying static files for wazuh-doc-images...[100%] img/loading.gif             
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 33%] cloud-security/amazon/services/prerequisites/dependenciwriting output... [100%] index                                                 
generating indices... done
writing additional pages... not_found moved-content search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in home/python/build/html.
[sphinx-autobuild] Serving on http://0.0.0.0:8000
[I 240509 13:11:28 handlers:92] Reload 3 waiters: /home/python/docs/cloud-security/amazon/services/prerequisites/dependencies.rst
[I 240509 13:11:28 handlers:135] Browser Connected: http://0.0.0.0:8000/cloud-security/amazon/services/prerequisites/dependencies.html
[I 240509 13:11:28 handlers:135] Browser Connected: http://0.0.0.0:8000/cloud-security/azure/activity-services/prerequisites/dependencies.html
[I 240509 13:11:29 handlers:135] Browser Connected: http://0.0.0.0:8000/cloud-security/gcp/prerequisites/dependencies.html

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@GGP1 GGP1 self-assigned this May 9, 2024
@GGP1 GGP1 linked an issue May 9, 2024 that may be closed by this pull request
@GGP1 GGP1 force-pushed the fix/6849-cloud-modules-templates branch from 68b40a4 to 8c17b97 Compare May 9, 2024 13:21
@fdalmaup fdalmaup self-requested a review May 10, 2024 08:42
fdalmaup
fdalmaup previously approved these changes May 10, 2024
Copy link
Member

@fdalmaup fdalmaup left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Selutario
Selutario previously approved these changes May 10, 2024
Copy link
Member

@Selutario Selutario left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@javimed javimed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the introductory text in dependencies.rst repeats as well, we could move it to a template.

You can configure the integration with |service_module| in the Wazuh manager or in a Wazuh agent. This choice merely depends on how you decide to access your AWS infrastructure in your environment.

The Wazuh manager includes all dependencies installed, these steps are only necessary when configuring the integration in a Wazuh agent.

source/_templates/cloud/pip_installation.rst Outdated Show resolved Hide resolved
source/_templates/cloud/python_installation.rst Outdated Show resolved Hide resolved
source/_templates/cloud/pip_installation.rst Outdated Show resolved Hide resolved
source/_templates/cloud/pip_installation.rst Outdated Show resolved Hide resolved
source/_templates/cloud/pip_installation.rst Outdated Show resolved Hide resolved
source/cloud-security/gcp/prerequisites/dependencies.rst Outdated Show resolved Hide resolved
@GGP1
Copy link
Member Author

GGP1 commented May 14, 2024

Since the introductory text in dependencies.rst repeats as well, we could move it to a template.

@javimed I didn't include the initial section in the template because custom replacements are not performed correctly.

var

@GGP1 GGP1 dismissed stale reviews from Selutario and fdalmaup via 20938ea May 14, 2024 12:59
@GGP1 GGP1 requested a review from javimed May 14, 2024 13:00
@GGP1 GGP1 force-pushed the fix/6849-cloud-modules-templates branch from 20938ea to f656325 Compare May 14, 2024 13:04
@GGP1 GGP1 requested a review from javimed May 14, 2024 14:25
@GGP1 GGP1 requested a review from javimed May 15, 2024 12:29
source/_templates/cloud/notes.rst Outdated Show resolved Hide resolved
source/_templates/cloud/notes.rst Outdated Show resolved Hide resolved
source/_templates/cloud/pip_installation.rst Outdated Show resolved Hide resolved
@GGP1 GGP1 requested a review from javimed May 15, 2024 17:04
@javimed javimed merged commit 957bbbe into 4.9.0 May 15, 2024
3 checks passed
@javimed javimed deleted the fix/6849-cloud-modules-templates branch May 15, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Centralize wazuh agent cloud modules dependencies installation
4 participants