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 docs on kubectl & helm access to pilot hubs #104

Merged
merged 1 commit into from
Nov 25, 2020
Merged

Add docs on kubectl & helm access to pilot hubs #104

merged 1 commit into from
Nov 25, 2020

Conversation

yuvipanda
Copy link
Member

Fixes #75

@choldgraf
Copy link
Member

choldgraf commented Nov 25, 2020

this looks great @yuvipanda - thanks for improving this! Perhaps @GeorgianaElena can have a quick look to see if anything is missing since she recently went through this process?

Non-blocking on this PR: I was wondering what you thought about a 2i2c practice of writing one sentence per line in documentation. This sometimes leads to long-ish lines, but I've found that it makes patching the markdown files easier to do via UIs such as GitHub's interactive editor, and is also a fairly intuitive decision-point to use rather than "how many characters does my line have". Curious what you think about that.

@yuvipanda yuvipanda merged commit e0f94ed into master Nov 25, 2020
@yuvipanda
Copy link
Member Author

Thanks @choldgraf!

She had only gone through the process of setting up for farallon hubs, nothing on Google cloud yet. We can use this as basis and modify as we go.

I mostly break lines wherever my editor does, and I think most text editors can be configured to break lines and reflow them as needed. This seems more automatic to me than breaking per sentence, since we would have to do that manually.

@choldgraf
Copy link
Member

sounds good 👍

re: lines - the main benefit I've found is that because GitHub's interactive UI requires you to add a suggestion to only one line, rather than multiple lines, this is where having "one sentence per line" is helpful. It's nothing crucial right now (and in the future we may be able to just use an auto-formatter like https://github.com/executablebooks/mdformat) but in the future we'll need to find practices that make editing and changing the markdown as easy as possible.

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.

Document how to get helm access to the 2i2c Pilot Hubs
2 participants