Documentation of Wazuh-QA repository #1066
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a mocked file for test-scan tests documentation
Changed materials theme color Improved index
Changed documentation theme features
Rebits
force-pushed
the
mkdocs-docstrings
branch
3 times, most recently
from
0bdb61b to
9872188
Compare
Rebits
force-pushed
the
mkdocs-docstrings
branch
from
9872188 to
4fec79e
Compare
BraulioV
suggested changes
Feb 16, 2021
tests/integration/test_active_response/test_execd/test_execd_firewall_drop.py
Outdated
Show resolved
Hide resolved
tests/integration/test_vulnerability_detector/test_providers/test_providers_enabled.py
Outdated
Show resolved
Hide resolved
Added shebang to provision documentation script Removed test documentation with conflicts in libraries
Rebits
force-pushed
the
mkdocs-docstrings
branch
3 times, most recently
from
9ce7fde to
08525a5
Compare
Rebits
force-pushed
the
mkdocs-docstrings
branch
from
08525a5 to
10bba80
Compare
BraulioV
previously approved these changes
Feb 17, 2021
BraulioV
approved these changes
Feb 17, 2021
This was referenced Feb 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello all,
This PR includes repository documentation using mkdocs with docstring. Adds a new docs repository, with test documentation as well as a dockerfile and scripts necessaries to provide it. Set up an index and directory structure for future documentation work.
It closes #1018
wazuh-qa-documentation.mp4
In order to build the documentation is necessary to run
provision_documentation.shscript in docs folder