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

Enhance Documentation with Subcategories for Resources and Data Sources #1255

Merged

Conversation

publi0
Copy link
Contributor

@publi0 publi0 commented Oct 20, 2024

This PR addresses the documentation improvement requested in issue #1233. It introduces subcategories for all resources and data sources in the DigitalOcean Terraform provider documentation, significantly improving readability and navigation on the Terraform Registry page.

Key changes:

  • Organized resources and data sources into logical subcategories
  • Followed the structure of the DigitalOcean control panel menu for categorization
  • Improved findability of related resources and data sources
  • Enhanced overall documentation structure for better user experience

This update will make it easier for users to locate specific resources and data sources, understand their relationships, and navigate the provider documentation more efficiently.

Closes #1233

Copy link
Member

@andrewsomething andrewsomething left a comment

Choose a reason for hiding this comment

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

🙏 Thank you! I think this will be a great improvement.

I did suggest one small change in-line to remain constant with the control panel's information hierarchy.

docs/resources/custom_image.md Outdated Show resolved Hide resolved
Co-authored-by: Andrew Starr-Bochicchio <[email protected]>
Copy link
Member

@andrewsomething andrewsomething left a comment

Choose a reason for hiding this comment

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

👍 Thanks again for this great contribution!

@andrewsomething andrewsomething merged commit bf9cce3 into digitalocean:main Oct 21, 2024
3 checks passed
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.

Improve Terraform Registry Documentation
2 participants