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

docs: documentation update and how it's generated #48

Merged
merged 6 commits into from
Jan 2, 2025

Conversation

Awlie
Copy link
Contributor

@Awlie Awlie commented Aug 6, 2024

  • added descriptions to resources in code for auto-generated docs
  • removed per-resource templates and added baseline ones
    • no more duplicating and adjusting template files and introducing copy paste errors
  • changed example structure so defaults in templates work out of the box (like .HasExample, .ExampleFile, .HasImport, .ImportFile)
    • formatted examples and fixed some spelling errors
    • added 3 imports
  • added imports, where it's declared in the code. I'm not 100% sure that it's correct, but should be
  • updated docs plugin to latest version
  • added subcategories in YAML Frontmatter. These are automatically generated through the description in code and the new templates
    • This allows us to define resources descriptions with My Subcategory --- The description of my resource and have the subcategory and description correctly filled in. It also works if people don't provide a subcategory, in that case, it will just populate the description.
      The only caveat is that people can't write --- in their description (or if we do, we should change this string to one that we will never write in our descriptions).
  • fixed some spelling errors
  • fixed md-page of cancom_ipam_instance, which had the description of another resource
  • added deprecated flag to a deprecated attribute of a resource (at least the description says so (resourceServiceUser.session_hash)

biggest change is for iam_policy.md, where i moved most of the text into the policy description, so that the information of the advanced usage is still there.

@Awlie Awlie marked this pull request as draft December 18, 2024 13:02
@atddo atddo self-requested a review December 18, 2024 13:46
@Awlie
Copy link
Contributor Author

Awlie commented Dec 18, 2024

in 619ac4b I migrated the new resource to the new proposed docs format

i also have some propositions to the descriptions of a few attributes, but i want to talk to CLR first

@Awlie
Copy link
Contributor Author

Awlie commented Dec 19, 2024

@roehlc You wanted to be tagged ;)
i adjusted some descriptions in 2ce9dee

@Awlie Awlie marked this pull request as ready for review December 19, 2024 17:42
Copy link
Collaborator

@atddo atddo left a comment

Choose a reason for hiding this comment

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

Nice work @Awlie !

@atddo atddo merged commit abb0499 into cancom:main Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants