docs: improve contributor workflow #237
Merged
+1,039
−345
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
Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
Adds a bootstrap target to install required go tools, similar to how other local repos handle this. Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
tiagolobocastro
force-pushed
the
dev
branch
3 times, most recently
from
ce2bcf3 to
4e6008f
Compare
Similar to the other local drivers, it can install the helm chart, run the tests, etc Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
Adds a nixos shell for local testing. This a headless vm with fs utils installed and configured for testing, as well as being a single node k3s cluster. Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
Add test pod graceful termination as 5s This speeds up tests by around 2m20s Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
For launch pods which don't restart, there's no point in waiting for the given timeout. Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
tiagolobocastro
force-pushed
the
dev
branch
2 times, most recently
from
4efd555 to
d61fe55
Compare
niladrih
reviewed
Jan 30, 2025
niladrih
approved these changes
Jan 30, 2025
Linted all the markdown files but noticed they have outdated content, example: installing openebs 3.X and operator lite Improve development setup guide, including the nixos-shell k3s docs Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
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.
Why is this PR required? What issue does it fix?:
Improves the existing docs.
Enhances the nix-shell and adds a nixos-shell which makes it incredibly easy to test changes.
Fix tiny bug where provision times out rather than failing.
Does this PR require any upgrade changes?:
No
Checklist:
<type>(<scope>): <subject>