wazuh-documentation icon indicating copy to clipboard operation
wazuh-documentation copied to clipboard

Published 20 hours ago • verified publisher icon wazuh

Add python and pip installation templates

Open GGP1 opened this issue 1 year ago • 0 comments

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

  • [x] 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

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

Writing style

  • [x] Uses present tense, active voice, and semi-formal registry.
  • [x] Uses short, simple sentences.
  • [x] 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 avatar May 09 '24 13:05 GGP1