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

fix(docs): Include product in relative link #34510

Merged
merged 1 commit into from
Feb 12, 2024

Conversation

ansgarm
Copy link
Member

@ansgarm ansgarm commented Jan 9, 2024

CDKTF uses these definitions to generate docs which end up on developer.hashicorp.com

There are content checks that fail for this link as the product (terraform) is required to be explicitly stated now

Related to hashicorp/terraform-cdk#2816

Target Release

1.7.x

Draft CHANGELOG entry

BUG FIXES

  • Relative URL in function definitions now correctly starts with /terraform

CDKTF uses these definitions to generate docs which end up on developer.hashicorp.com

There are content checks that fail for this link as the product (terraform) is required to be explicitly stated now
@radeksimko
Copy link
Member

I think it is reasonable to assume that the links are relative to developer.hashicorp.com but I believe that the "base" was previously terraform.io and so this link was in fact valid in the past.

I filed #34660 to discuss some more longer-term solutions.

@radeksimko radeksimko merged commit cd13064 into hashicorp:main Feb 12, 2024
6 checks passed
Copy link
Contributor

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants