freeCodeCamp / freeCodeCamp/devdocs
Add 'data source' and 'resource' to Terraform entries
- Dominant language
- Ruby
- Stars
- 39.5k
- Forks
- 2.6k
- Avg merge
- 4d 32m
- Merged PRs (30d)
- 13
Description
# Feature request
## Problem Summary
when searching for Terraform resources, e.g. `aws_ecs_task_definition`, it's difficult to tell which is the 'data source' entry and which is the 'resource' entry:
this can make it significantly harder to use DevDocs for finding Terraform docs, as opposed to the official Terraform docs which denote the different resource based on a kind of 'directory' structure:
## Proposed Solution
add `(resource)` and `(data source)` suffixes to the respective listings for Terraform entries:
---
happy to create a PR to implement this! would appreciate any pointers for starting files as I haven't contributed to the repo before :)
Contributor guide
Research direction
Start by locating how Terraform entries are generated and how their names are displayed in DevDocs. Confirm the relevant metadata distinguishes resources from data sources, then verify that the respective listings show the requested “(resource)” and “(data source)” suffixes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- terraform
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100