suborbital / docs

Documentation monorepo for Suborbital projects and products
https://docs.suborbital.dev
Apache License 2.0
8 stars 5 forks source link

Add local deployment docs #158

Closed hola-soy-milk closed 2 years ago

hola-soy-milk commented 2 years ago

This condenses the minikube deployment journey into a Local Deployment tutorial.

I'm unsure how much to have in here, such as manually getting an editor token. I find it helpful for getting to know Compute, but maybe it's not relevant to local deployment?

Thank you for any feedback!

github-actions[bot] commented 2 years ago

10 total issues, 1 error, and 9 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

πŸ“ docs | :octocat: repo | πŸ™‹πŸ½β€β™€οΈ issues | πŸͺ marketplace | A11yWatch

flaki commented 2 years ago

I'm unsure how much to have in here, such as manually getting an editor token. I find it helpful for getting to know Compute, but maybe it's not relevant to local deployment?

Dunno, I kinda feel like that may be its own docs page (and you could link it here)? I shall admit I'm not entirely sure where such a page would position itself on the Documentation <-> Tutorial axis...

hola-soy-milk commented 2 years ago

I'm unsure how much to have in here, such as manually getting an editor token. I find it helpful for getting to know Compute, but maybe it's not relevant to local deployment?

Dunno, I kinda feel like that may be its own docs page (and you could link it here)? I shall admit I'm not entirely sure where such a page would position itself on the Documentation <-> Tutorial axis...

Thank you! I'm kinda leaning this way too, and would love to hear what the rest think, please!

LauraLangdon commented 2 years ago

Ooh, this is my first time navigating future merge conflicts! On my branch where I'm updating the Compute docs, I've created a subcategory Compute -> Deploying Compute, and this doc would belong in there. But if I'm reading this correctly, your PR here would create Compute -> Local Deployment -> Local Deployment. What's the protocol in this sort of situation? Like we can just merge this and then I can move the doc in my subcategory on my branch, but I just thought I'd check to see if there's a different established procedure. ☺️

github-actions[bot] commented 2 years ago

10 total issues, 1 error, and 9 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

πŸ“ docs | :octocat: repo | πŸ™‹πŸ½β€β™€οΈ issues | πŸͺ marketplace | A11yWatch

hola-soy-milk commented 2 years ago

Ooh, this is my first time navigating future merge conflicts! On my branch where I'm updating the Compute docs, I've created a subcategory Compute -> Deploying Compute, and this doc would belong in there. But if I'm reading this correctly, your PR here would create Compute -> Local Deployment -> Local Deployment. What's the protocol in this sort of situation? Like we can just merge this and then I can move the doc in my subcategory on my branch, but I just thought I'd check to see if there's a different established procedure. ☺️

Seeing as we'll likely be merging your change first, I can adapt mine to fit this new structure! πŸ˜„ Thanks for catching this!

github-actions[bot] commented 2 years ago

10 total issues, 1 error, and 9 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

πŸ“ docs | :octocat: repo | πŸ™‹πŸ½β€β™€οΈ issues | πŸͺ marketplace | A11yWatch

LauraLangdon commented 2 years ago

Ooh, this is my first time navigating future merge conflicts! On my branch where I'm updating the Compute docs, I've created a subcategory Compute -> Deploying Compute, and this doc would belong in there. But if I'm reading this correctly, your PR here would create Compute -> Local Deployment -> Local Deployment. What's the protocol in this sort of situation? Like we can just merge this and then I can move the doc in my subcategory on my branch, but I just thought I'd check to see if there's a different established procedure. ☺️

Seeing as we'll likely be merging your change first, I can adapt mine to fit this new structure! πŸ˜„ Thanks for catching this!

Cheers! LGMT!

flaki commented 2 years ago

@LauraLangdon is there a process for dealing with/pleasing the spell checker? "prefilled" vs "pre-filled" could probably be fixed but [N|n]grok and [M|m]inikube will probably need to be added to be "learned"?

LauraLangdon commented 2 years ago

@LauraLangdon is there a process for dealing with/pleasing the spell checker? "prefilled" vs "pre-filled" could probably be fixed but [N|n]grok and [M|m]inikube will probably need to be added to be "learned"?

Literally just adding both capitalization versions of both words to spelling.dic (apparently my phone's keyboard doesn't do back ticks πŸ™„).

I can do that in a bit to save RamΓ³n the hassle.

github-actions[bot] commented 2 years ago

10 total issues, 1 error, and 9 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

πŸ“ docs | :octocat: repo | πŸ™‹πŸ½β€β™€οΈ issues | πŸͺ marketplace | A11yWatch

github-actions[bot] commented 2 years ago

10 total issues, 1 error, and 9 warnings found for docs.suborbital.dev

Details

ERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail ```html Search ``` This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.27:1. Recommendation: change text colour to #000610. ---
WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 ```html

πŸ“ docs | :octocat: repo | πŸ™‹πŸ½β€β™€οΈ issues | πŸͺ marketplace | A11yWatch

hola-soy-milk commented 2 years ago

Oooh! Thank you both for looking into this

hola-soy-milk commented 2 years ago

Thank you all for approving!

Not sure why the Github Pages build is failing, will investigate.

As discussed, once #155 is merged, I'll rebase and restructure this so it fits in nicely and will then merge πŸ˜„

LauraLangdon commented 2 years ago

Not sure why the Github Pages build is failing, will investigate.

I think it's all good, just that the check doesn't like it when it runs and there are no changes to the site content (like when I pushed my additions to the dictionary).

image

hola-soy-milk commented 2 years ago

Got it!! Thanks for clarifying