Skip to content

Remove website prefix from generated docs#2028

Merged
lkysow merged 1 commit intomainfrom
lkysow/docs-gen
Mar 21, 2023
Merged

Remove website prefix from generated docs#2028
lkysow merged 1 commit intomainfrom
lkysow/docs-gen

Conversation

@lkysow
Copy link
Copy Markdown
Contributor

@lkysow lkysow commented Mar 21, 2023

Website has linting that errors when links have the developer.hashicorp.com prefix.

Website has linting that errors when links have the
developer.hashicorp.com prefix.
@lkysow lkysow requested a review from david-yu March 21, 2023 16:27
@lkysow lkysow added pr/no-changelog PR does not need a corresponding .changelog entry pr/no-backport signals that a PR will not contain a backport label labels Mar 21, 2023
@david-yu
Copy link
Copy Markdown
Contributor

Also cc @im2nguyen who should review this as well.

@david-yu david-yu requested a review from im2nguyen March 21, 2023 16:30
docsStr := strings.Join(children, "\n\n")
docsStr = strings.ReplaceAll(docsStr, "[Enterprise Only]", "<EnterpriseAlert inline />")
// Remove https://developer.hashicorp.com prefix from links because docs linting requires it.
docsStr = strings.ReplaceAll(docsStr, "https://developer.hashicorp.com/", "/")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this should work. just wanted to call out that consul's docs live at https://developer.hashicorp.com/consul/docs, does this account for the /consul?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

just confirmed that it does, feel free to merge when ready!

@lkysow lkysow merged commit 7d098bd into main Mar 21, 2023
@lkysow lkysow deleted the lkysow/docs-gen branch March 21, 2023 18:19
asheshvidyut pushed a commit that referenced this pull request Aug 4, 2023
Website has linting that errors when links have the
developer.hashicorp.com prefix.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr/no-backport signals that a PR will not contain a backport label pr/no-changelog PR does not need a corresponding .changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants