Skip to content

docs: added subcommands docs page - #110

Merged
TylerGillson merged 11 commits into
mainfrom
subcommands-docs
Aug 1, 2024
Merged

docs: added subcommands docs page#110
TylerGillson merged 11 commits into
mainfrom
subcommands-docs

Conversation

@karl-cardenas-coding

Copy link
Copy Markdown
Contributor

Issue

N/A

Description

This PR adds a documentation page that goes into greater detail about each subcommand.

@karl-cardenas-coding
karl-cardenas-coding marked this pull request as ready for review July 31, 2024 16:35
@karl-cardenas-coding
karl-cardenas-coding requested a review from a team as a code owner July 31, 2024 16:35
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 31, 2024

@TylerGillson TylerGillson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you @karl-cardenas-coding! This is awesome and much appreciated. I regret to mention that some significant changes to these commands will be happening soon in validator-labs/validator#294.

Comment thread docs/subcommands.md Outdated
Comment thread docs/subcommands.md Outdated
Comment thread docs/subcommands.md Outdated
Comment thread docs/subcommands.md
Comment thread docs/subcommands.md Outdated
Comment thread docs/subcommands.md Outdated
@karl-cardenas-coding

Copy link
Copy Markdown
Contributor Author

@TylerGillson Thanks for the feedback. I went ahead and pushed up the changes :)

Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
TylerGillson
TylerGillson previously approved these changes Jul 31, 2024
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 31, 2024
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
@TylerGillson

TylerGillson commented Jul 31, 2024

Copy link
Copy Markdown
Member

fyi @karl-cardenas-coding tests are breaking due to the version bump enforced via make reviewable.

@ahmad-ibra is working on the fix in a separate PR.

We'll update and merge this one as soon as his changes to properly upgrade the validator version are in.

@ahmad-ibra

ahmad-ibra commented Jul 31, 2024

Copy link
Copy Markdown
Member

@karl-cardenas-coding heads up that we'll need to wait for #115 to be merged before this PR goes in. Once the PR i linked is merged the test failures we see in CI will be addressed.

Edit: @TylerGillson beat me to the explanation 🙃

@karl-cardenas-coding

Copy link
Copy Markdown
Contributor Author

All good gents 👍

Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
@TylerGillson
TylerGillson merged commit 9fa23dc into main Aug 1, 2024
@TylerGillson
TylerGillson deleted the subcommands-docs branch August 1, 2024 16:51
TylerGillson added a commit that referenced this pull request Aug 1, 2024
## Issue
Resolves #109
Resolves #98

## Description
Add `validatorctl docs` command to display supported versions of
validator & validator plugins.

Sample output:
![Screen Shot 2024-07-31 at 2 45 56
PM](https://github.com/user-attachments/assets/af936308-afc0-4f79-aee8-7ea81fd26780)

Requires:
- #110

---------

Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>
TylerGillson added a commit that referenced this pull request Aug 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.1.0](v0.0.6...v0.1.0)
(2024-08-06)


### ⚠ BREAKING CHANGES

* split plugin rule configuration and installation into separate
commands
([#121](#121))

### Features

* add docs command; refactor to use embeddedfs pkg
([#116](#116))
([dbe19c5](dbe19c5))
* read CA certs for network rules, add HTTPFileRules, AMIRules
([#117](#117))
([0c4487f](0c4487f))
* support direct rule evaluation with `validator check --direct`
([#127](#127))
([f1fb0d6](f1fb0d6))


### Docs

* added subcommands docs page
([#110](#110))
([9fa23dc](9fa23dc))


### Dependency Updates

* **deps:** update github.com/validator-labs/validator-plugin-azure
digest to ba947e3
([#134](#134))
([2a1058d](2a1058d))
* **deps:** update github.com/validator-labs/validator-plugin-vsphere
digest to 9b1f05b
([#135](#135))
([253f328](253f328))


### Refactoring

* remove -s flag
([#126](#126))
([9373e02](9373e02))
* simplify helm prompts
([#115](#115))
([8ce75a1](8ce75a1))
* split plugin rule configuration and installation into separate
commands
([#121](#121))
([6eaee77](6eaee77))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants