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 scaffolding of /docs directory and workflow to deploy #7303

Merged
merged 7 commits into from
Feb 19, 2025

Conversation

Desvelao
Copy link
Member

@Desvelao Desvelao commented Feb 18, 2025

Description

This pull request adds the scaffolding of docs directory according to the documentation specification.

Changes

  • Add docs scaffolding
  • Add badge to README.md of docs deployment

Issues Resolved

#7291

Evidence

image

Test

Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

Other

Test Result
Go to docs directory and run the server.sh script and ensure the documentation is accessible from browser and review the pages
Go to docs directory and run the build.sh script and ensure the documentation built into the book directory

Details

⚫ Go to docs directory and run the server.sh script and ensure the documentation is accessible from browser and review the pages
⚫ Go to docs directory and run the build.sh script and ensure the documentation built into the book directory

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@Desvelao Desvelao self-assigned this Feb 18, 2025
@Desvelao Desvelao linked an issue Feb 18, 2025 that may be closed by this pull request
1 task
@Desvelao Desvelao marked this pull request as ready for review February 18, 2025 15:17
@guidomodarelli guidomodarelli self-requested a review February 18, 2025 15:28
Copy link
Contributor

Wazuh Check Updates plugin code coverage (Jest) test % values
Statements 76.44% ( 172 / 225 )
Branches 58.65% ( 61 / 104 )
Functions 61.7% ( 29 / 47 )
Lines 76.44% ( 172 / 225 )

Copy link
Contributor

Wazuh Core plugin code coverage (Jest) test % values
Statements 27.16% ( 640 / 2356 )
Branches 28.75% ( 335 / 1165 )
Functions 24.84% ( 163 / 656 )
Lines 27.28% ( 635 / 2327 )

Copy link
Contributor

@guidomodarelli guidomodarelli left a comment

Choose a reason for hiding this comment

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

LGTM 🟢

@chantal-kelm chantal-kelm self-requested a review February 19, 2025 12:07
Copy link
Member

@chantal-kelm chantal-kelm left a comment

Choose a reason for hiding this comment

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

LGTM!

@asteriscos asteriscos merged commit 623f045 into main Feb 19, 2025
5 checks passed
@asteriscos asteriscos deleted the enhancement/7291-add-docs branch February 19, 2025 12:36
@asteriscos asteriscos mentioned this pull request Feb 19, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MVP catch up - documentation
4 participants