docs: remove subcommand docs from repo #205
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
dosubot
bot
added
size:XL
TylerGillson
previously approved these changes
Sep 3, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## main #205 +/- ##
=======================================
Coverage 53.33% 53.33%
=======================================
Files 45 45
Lines 6253 6253
=======================================
Hits 3335 3335
Misses 2073 2073
Partials 845 845 Continue to review full report in Codecov by Sentry.
|
mattwelke
added a commit
to validator-labs/docs
that referenced
this pull request
Sep 5, 2024
## Description The first real update to the repo to add our docs contents. * Removes Docusaurus and Facebook branding. Replaces it with a slight modification of the built in theme to replace the green color palette with a blue one. New graphics from [SVG Repo](https://www.svgrepo.com) and [undraw](https://undraw.co/) that use blue and orange as their color scheme. This is designed to match the blue and orange we got from our AI-generated logo. * Replaces placeholder docs content with content for Validator. A Community page links them to all the ways they can get in touch with us. * Removes `test-deploy.yml` GHA workflow. It was redundant because we have Netlify trying to build our site which is set up as a required check. If site builds are broken, PRs cannot be merged. I also wanted to add a call to action to the splash page (maybe a "read more" button to bring them to the first docs page) but I couldn't figure out the CSS for now. Maybe we can add that later. When this is merged, other changes should be made to remove documentation that we're centralizing here: * validator-labs/validatorctl#205 * Clear away description from GitHub org page, replace it with something short and sweet with a link to the new docs site. --------- Signed-off-by: Matt Welke <matt.welke@spectrocloud.com>
We have command reference docs on our main documentation site now. Signed-off-by: Matt Welke <matt.welke@spectrocloud.com>
mattwelke
force-pushed
the
chore/remove-subdommand-docs
branch
from
8eef492
to
f23408b
Compare
Signed-off-by: Matt Welke <matt.welke@spectrocloud.com>
TylerGillson
approved these changes
Sep 5, 2024
TylerGillson
added a commit
that referenced
this pull request
Sep 11, 2024
🤖 I have created a release *beep* *boop* --- ## [0.2.0](v0.1.4...v0.2.0) (2024-09-11) ### ⚠ BREAKING CHANGES * remove role privilege rules ([#217](#217)) ### Features * add --custom-resources flag to validator rules check as an alternate to -f ([#218](#218)) ([4aa14b6](4aa14b6)) ### Bug Fixes * add missing Host.Config.Storage privilege & document ([#212](#212)) ([c7408a6](c7408a6)) ### Docs * remove subcommand docs from repo ([#205](#205)) ([57ca6cb](57ca6cb)) ### Dependency Updates * **deps:** update golang.org/x/exp digest to e7e105d ([#214](#214)) ([c4ac163](c4ac163)) ### Refactoring * remove role privilege rules ([#217](#217)) ([b0976db](b0976db)) * update `executePlugins` function to operate on a slice of `PluginSpec`'s ([#206](#206)) ([97875f3](97875f3)) --- 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
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.
Description
We have command reference docs on our main documentation site now. See https://validator-labs.github.io/docs.
validator-labs/docs#3 must be merged first.