Skip to content

Change amazonec2-security-group to XXXX in example

Shem Gyll requested to merge shemgyll-change-security-group-example into main

What does this MR do?

In this example config.toml, we previous had the following line:

"amazonec2-security-group=docker-machine-scaler",

This was causing confusion for users who may have been copying the example, since this value needs to be set to according to the user's instance (and not a universal value). I have hence updated the example to the following to make it consistent with the other parameters:

"amazonec2-security-group=XXXX",

Related issues

@steveazz I've change the docs according to your comment in the above issue. Please let me know if there's any reason it shouldn't be changed.

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.

Merge request reports