Add local deployment docs #158
Conversation
hola-soy-milk
requested review from
callahad,
flaki,
jessicarose and
LauraLangdon
10 total issues, 1 error, and 9 warnings found for docs.suborbital.devDetailsERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail <span class="DocSearch-Button-Placeholder">Search</span>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 <div class="home__other__item"><a href="/grav" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/vektor" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/reactr" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/sat" class="link"><im...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/atmo" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="navbar__items navbar__items--right"><a href="https://suborbital.dev...</div>
If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_10.C32,C31,C33,C38,SCR34,G206 <a href="#" class="skipToContent_ZgBM">Skip to main content</a>This element has "position: fixed". This may require scrolling in two dimensions, which is considered a failure of this Success Criterion. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span style="font-weight: bold; color: red;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. 📝 docs | |
repo
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! |
|
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. |
10 total issues, 1 error, and 9 warnings found for docs.suborbital.devDetailsERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail <span class="DocSearch-Button-Placeholder">Search</span>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 <div class="home__other__item"><a href="/grav" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/vektor" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/reactr" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/sat" class="link"><im...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/atmo" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="navbar__items navbar__items--right"><a href="https://suborbital.dev...</div>
If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_10.C32,C31,C33,C38,SCR34,G206 <a href="#" class="skipToContent_ZgBM">Skip to main content</a>This element has "position: fixed". This may require scrolling in two dimensions, which is considered a failure of this Success Criterion. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span style="font-weight: bold; color: red;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. 📝 docs | |
Seeing as we'll likely be merging your change first, I can adapt mine to fit this new structure! 😄 Thanks for catching this! |
10 total issues, 1 error, and 9 warnings found for docs.suborbital.devDetailsERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail <span class="DocSearch-Button-Placeholder">Search</span>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 <div class="home__other__item"><a href="/grav" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/vektor" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/reactr" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/sat" class="link"><im...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/atmo" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="navbar__items navbar__items--right"><a href="https://suborbital.dev...</div>
If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_10.C32,C31,C33,C38,SCR34,G206 <a href="#" class="skipToContent_ZgBM">Skip to main content</a>This element has "position: fixed". This may require scrolling in two dimensions, which is considered a failure of this Success Criterion. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span style="font-weight: bold; color: red;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. 📝 docs | |
Cheers! LGMT! |
|
@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. |
10 total issues, 1 error, and 9 warnings found for docs.suborbital.devDetailsERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail <span class="DocSearch-Button-Placeholder">Search</span>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 <div class="home__other__item"><a href="/grav" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/vektor" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/reactr" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/sat" class="link"><im...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/atmo" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="navbar__items navbar__items--right"><a href="https://suborbital.dev...</div>
If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_10.C32,C31,C33,C38,SCR34,G206 <a href="#" class="skipToContent_ZgBM">Skip to main content</a>This element has "position: fixed". This may require scrolling in two dimensions, which is considered a failure of this Success Criterion. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span style="font-weight: bold; color: red;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. 📝 docs | |
10 total issues, 1 error, and 9 warnings found for docs.suborbital.devDetailsERROR WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail <span class="DocSearch-Button-Placeholder">Search</span>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 <div class="home__other__item"><a href="/grav" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/vektor" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__other__item"><a href="/reactr" class="link">...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/sat" class="link"><im...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="home__flagship__item"><a href="/atmo" class="link"><i...</div>If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_3.1_3_1.H48 <div class="navbar__items navbar__items--right"><a href="https://suborbital.dev...</div>
If this element contains a navigation section, it is recommended that it be marked up as a list. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_10.C32,C31,C33,C38,SCR34,G206 <a href="#" class="skipToContent_ZgBM">Skip to main content</a>This element has "position: fixed". This may require scrolling in two dimensions, which is considered a failure of this Success Criterion. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. WARNING WCAG2AA.Principle1.Guideline1_4.1_4_3_F24.F24.FGColour <span style="font-weight: bold; color: red;">/</span>Check that this element has an inherited background colour or image to complement the corresponding inline foreground colour. 📝 docs | |
|
Oooh! Thank you both for looking into this |
|
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 😄 |
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).
|
|
Got it!! Thanks for clarifying |
|
|
||
| You will be asked for a domain. Please make sure to enter your domain from ngrok. | ||
|
|
||
| These will now live in the `.suborbital/` folder. |
There was a problem hiding this comment.
What are the "these"? Maybe the manifest files?
There was a problem hiding this comment.
Yes they are! Fixing this post haste, thank you!
|
|
||
| This can only be done as [an API call to the control plane service](https://docs.suborbital.dev/compute/integrate-the-function-editor/code-editor) from within your cluster. Since we’re currently not running an app in our cluster, we’ll just make the call from within! | ||
|
|
||
| First, we’ll need the name of our control plane pod: |
There was a problem hiding this comment.
How could we change this control plane reference to something that means the same thing but doesn't refer to the control plane?
There was a problem hiding this comment.
Could you please expand on this @LauraLangdon? I understand we're doing away with references to the control plane, so this would be an API call?
| - `EDITOR_TOKEN`: The token generated by the control plane API in step 8 | ||
| - `IDENT`: Customer identity, for example: `com.example.12345` | ||
| - `FUNCTION_NAME` : A name for your function | ||
| - `LANGUAGE_TEMPLATE`: [A template to be prefilled](https://docs.suborbital.dev/compute/integrate-the-function-editor/code-editor#configuration) when opening the editor for a new function, defaulting to `AssemblyScript`. |
There was a problem hiding this comment.
This link will change and can be made relative, too: ./customizing-functions/code-editor#configuration
Co-authored-by: Laura Langdon <[email protected]>
Co-authored-by: Laura Langdon <[email protected]>
Co-authored-by: Laura Langdon <[email protected]>
Co-authored-by: Laura Langdon <[email protected]>
Co-authored-by: Laura Langdon <[email protected]>
Co-authored-by: Laura Langdon <[email protected]>
* Add local deployment docs * Restructure to be 'with Minikube' * Adopt lovely feedback * add words to dictionary * add more words to dictionary * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Apply feedback * Rename subcategory to Other Deployments * Lowercase minikube * Remove trailing comma Co-authored-by: Laura Langdon <[email protected]> Co-authored-by: Laura Langdon <[email protected]>
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!