Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

Documentation: Differentiate between data sources and resources better #18

Closed
craigmonson opened this issue Sep 5, 2017 · 4 comments
Closed

Comments

@craigmonson
Copy link
Contributor

I did a search for something specific relating to aws_vpc. Terraform documentation is very good, so I was able to plop to the page rather quickly. Looking for a specific problem, I scanned down the aws_vpc page (https://www.terraform.io/docs/providers/aws/d/vpc.html), and saw what I was looking for (Attributes). However, I didn't realize I was looking at the page for the data source, and not the resource. It was confusing, as both are organized very similarly, and there's no big differentiation between them.

I propose adding a simple "Data Source: " before the header to make it more clear:

Data Source: aws_vpc

I think that'd make data sources more visible in the documentation. I'll be happy to put this together, but I'd rather get a "go for it" before investing some time.

Thanks!

@jnoss
Copy link

jnoss commented Oct 2, 2017

I also had this issue with AWS provider documentation. I think it's unique to the AWS provider, because only that provider has so many data sources that they scroll off the bottom of the page in the nav bar (which makes it unclear that there are other sections to navigate to).

I agree that adding "Data Source: " to the data source page titles/headers would help to clarify this.

Another route to fixing this would be the ability to collapse the navigation bar on the left - perhaps even start the nav bar collapsed, so a user can choose to click in to "Data Sources" if desired, or into the resource categories themselves. Is that something that would be considered?

@RavenAlly
Copy link

terraform-providers/terraform-provider-aws pull request #2422 submitted.

@diroussel
Copy link

This ticket can be closed as hashicorp/terraform-provider-aws#2713 is merged

@craigmonson
Copy link
Contributor Author

YAY! You guys rock!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants