-
Notifications
You must be signed in to change notification settings - Fork 64
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
docs: Add section on helpful tools #497
Conversation
This document can collect tools that are required to work with the infrastructure deployed from this repo, and any additional tips / resources that are specifically useful to us. The hope is that this list grows over time as we gain more experience. Ref 2i2c-org#476
|
||
#### Tips | ||
|
||
- Consider aliasing it to `k`, as you might be typing it a lot! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is a good idea although I would keep kubectl
in our docs when we showcase commands...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I agree!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great start!!
And I agree this is something to iterate on... so 👍 on merging early than later!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love it! 💖 Also agree with @damianavila that this can be iterated upon and I think it's fine to merge as is and open new PRs as folk discover new things :)
Pinging @consideRatio who probably knows a bunch of useful tools and tricks |
Some tricks using the
|
A PR adding these tricks is more than welcome 😜 ! |
Thanks for the nudge @damianavila. I'm relieved to see markdown based documentation instead of rST 😌 - I'm totally sold on the use of MyST for project documentation atm. #499 opened |
This document can collect tools that are required to work
with the infrastructure deployed from this repo, and any
additional tips / resources that are specifically useful
to us. The hope is that this list grows over time as we gain
more experience.
Ref #476