hashicorp / hashicorp/terraform-docs-common
Enterprise Docs' "Edit this page on GitHub" hyperlink is Invalid
- Dominant language
- Makefile
- Stars
- 36
- Forks
- 133
- PR merge metrics
- No merged PRs in 30d
Description
The "Edit this page on GitHub" hyperlink on the bottom of every Enterprise doc page is invalid, as it's still referencing (presumably) an old repo. After reading the README of this repo, it does mention the repo for `/enterprise` is an internal repository, so I can't say for certain if the currently linked repo is deprecated or not as I do not have the needed access to verify.
I'd suggest that if the public is unable to access the docs and modify it themselves via the usual method of submitting a PR, then can we please have some other kind of link so that we can put in a request for changes to be made elsewhere?
Example:
https://developer.hashicorp.com/terraform/enterprise/api-docs/workspaces#show-workspace

Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the repository README and inspect how the Enterprise documentation page at the provided example URL generates its “Edit this page on GitHub” link. Confirm whether the destination is inaccessible or outdated, then update the link or provide an alternative change-request destination and verify it from an Enterprise docs page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- terraform
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100