Skip to content

Making things a little more obvious for those of us who may skip ahead

Davis Bickford requested to merge dbickford-docs-suggestion into main

What does this MR do?

Adds some extra caution / attention to environment for those who may partake in the video tutorials. If anyone skips over the section above, they may be in for a bad time if they try to set up a default debian machine in GCP.

A couple examples of ways someone could get stuck if they use a default GCP machine:

  • The selected GCP machine series must support nested virtualization, and it must be created and configured via command line, it can't be done in the console. If you select the wrong machine series, no amount of CLI will conjure up a kvm device in the machine and it will be difficult to discover a new machine needs to be created.
  • 10GB disk will not be sufficient. Rancher Desktop will install but fail to run. kubectl version will give errors of The connection to the server 127.0.0.1:6443 was refused - did you specify the right host or port? which makes it extra tricky to pin down the cause is disk size.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Davis Bickford

Merge request reports