🧹 Improve the resource docs

[tas50]

Comment updates to improve the generated docs

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (1)

oneshot

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the git@github.com:mondoohq/cnquery.git repository
on the tas50/docs_updates branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/c635c2f3f714eec2fcf27b643a1919b9a811ef2e/apply.pl' |
perl - 'https://github.com/mondoohq/cnquery/actions/runs/21682387198/attempts/2' &&
git commit -m 'Update check-spelling metadata'

Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (178) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary	Entries	Covers	Uniquely
cspell:node/dict/node.txt	891	6	3
cspell:python/src/python/python-lib.txt	2417	3
cspell:fullstack/dict/fullstack.txt	419	2	1
cspell:java/src/java-terms.txt	920	2	1
cspell:python/src/python/python.txt	392	2

Consider adding them (in .github/workflows/spell-check.yaml) in jobs:/spelling: for uses: check-spelling/check-spelling@c635c2f3f714eec2fcf27b643a1919b9a811ef2e in its with:

      with:
        extra_dictionaries: |
          cspell:node/dict/node.txt
          cspell:python/src/python/python-lib.txt
          cspell:fullstack/dict/fullstack.txt
          cspell:java/src/java-terms.txt
          cspell:python/src/python/python.txt

To stop checking additional dictionaries, add (in .github/workflows/spell-check.yaml) for uses: check-spelling/check-spelling@c635c2f3f714eec2fcf27b643a1919b9a811ef2e in its with:

check_extra_dictionaries: ""

If the flagged items are false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it,
  try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

[Copilot]

Pull request overview

This PR improves documentation comments across multiple provider resource definition files (.lr files). The changes enhance the clarity and completeness of generated documentation by adding examples, fixing typos, improving descriptions, and updating deprecation notices.

Changes:

• Updated deprecation notices to reference version 13.0 instead of 12.0
• Enhanced field descriptions with examples and clarifying details (e.g., enum values, configuration options)
• Fixed typos and improved grammar in documentation comments
• Standardized capitalization and formatting in comments

Reviewed changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
providers/vsphere/resources/vsphere.lr	Updated deprecation notice to version 13.0 and added enum values for VIB acceptance levels
providers/terraform/resources/terraform.lr	Fixed spacing in comment for module directory path
providers/os/resources/os.lr	Updated multiple deprecation notices to version 13.0, improved descriptions with examples (SSH keys, logging flags, service types, container states, etc.)
providers/opcua/resources/opcua.lr	Added example server states to clarify field values
providers/network/resources/network.lr	Enhanced DNS record rdata description with examples
providers/ms365/resources/ms365.lr	Improved descriptions throughout, including filter examples, user settings, authentication methods, and risk levels
providers/k8s/resources/k8s.lr	Capitalized "Environment variables" for consistency
providers/google-workspace/resources/google-workspace.lr	Fixed spacing in comment for user creation time
providers/github/resources/github.lr	Capitalized "URL" in release URL comment and improved webhook config description
providers/gcp/resources/gcp.lr	Standardized "Internal ID for this resource" comments, fixed typos, improved descriptions for Redis endpoints, instance metadata, scheduling options, and many other fields
providers/core/resources/core.lr	Improved CPE "other" field description
providers/cloudflare/resources/cloudflare.lr	Capitalized "ID" in resource ID comment
providers/azure/resources/azure.lr	Enhanced descriptions for batch pool properties, storage metrics, hosting environment fields, and fixed duplicate "Recommendation risk" comment
providers/aws/resources/aws.lr	Fixed typo in backup setting and improved CORS rule description

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Extra apostrophe in "they're' automatically". This should be "they're automatically" (only one apostrophe after the 'e').

[Copilot]

Incorrect capitalization. The word "The" on line 622 should be lowercase "the" since it continues the sentence from line 621: "May be initialized with the name only, in which case it will look up the package with the given name on the system."

Suggested change

	// The package with the given name on the system.
	// the package with the given name on the system.

[VasilSirakov]

We could start to enforce backticks in some places instead of single quotes depending on how we want it to look in the README.

[Copilot]

@tas50 I've opened a new pull request, #6568, to work on those changes. Once the pull request is ready, I'll request review from you.

[tas50]

Let me generate this and then see what we want to modify project wide. Easy enough to go either direction