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 best practices documentation and update other docs #3938

Merged
merged 2 commits into from
Apr 16, 2024

Conversation

matthchr
Copy link
Member

  • Added general and security best practices sections.
  • Updated FAQ to discuss CVE patching.
  • Moved to use more visible warnings/notes in ASOv1 -> ASOv2 migration
    guide.

This fixes #3261.

If applicable:

  • this PR contains documentation
  • this PR contains tests
  • this PR contains YAML Samples

Copy link
Collaborator

@super-harsh super-harsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a few minors

docs/hugo/content/_index.md Show resolved Hide resolved
--set crdPattern=resources.azure.com/*;containerservice.azure.com/*;keyvault.azure.com/*;managedidentity.azure.com/*;eventhub.azure.com/*
```
{{% /tab %}}
{{% tab header="CMD" %}}
Copy link
Member

@theunrepentantgeek theunrepentantgeek Apr 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove CMD? We know we have users using this.

You could say "Create a file with the following content, and then apply it as follows" or similar.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is the file needs the env variables embedded in it... maybe I can write a multiline cmd that creates the file using the env variables... though not 100% sure how to do that without EOF

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Show a sample with placeholders and give them an instruction to replace the values?

Copy link
Member

@theunrepentantgeek theunrepentantgeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice docs. A few comments, nothing major.

docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/asov1-asov2-migration/_index.md Outdated Show resolved Hide resolved
docs/hugo/content/guide/best-practices/security.md Outdated Show resolved Hide resolved
@matthchr matthchr force-pushed the feature/more-docs branch from 5350421 to 695a8a0 Compare April 16, 2024 01:43
@matthchr
Copy link
Member Author

/ok-to-test sha=695a8a0

* Added general and security best practices sections.
* Updated FAQ to discuss CVE patching.
* Moved to use more visible warnings/notes in ASOv1 -> ASOv2 migration
  guide.

This fixes Azure#3261.
@matthchr matthchr force-pushed the feature/more-docs branch from 695a8a0 to f56ca7b Compare April 16, 2024 03:54
@matthchr
Copy link
Member Author

/ok-to-test sha=f56ca7b

@matthchr matthchr added this pull request to the merge queue Apr 16, 2024
Merged via the queue into Azure:main with commit 2d8d216 Apr 16, 2024
9 checks passed
@matthchr matthchr deleted the feature/more-docs branch April 16, 2024 16:48
@matthchr matthchr added the documentation Improvements or additions to documentation label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

Document our CVE patching stance
3 participants