Skip to content

Commit

Permalink
Merge #11569
Browse files Browse the repository at this point in the history
11569: adding slash to gen.go links for seo reasons r=susanev a=susanev

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

seo requires that links end consistently.
we care about seo because it impacts organic search.

because we use hugo, we have a constraint that links need to end in a slash.
but we have many links that don't end in a slash.
this is attempting to fix some of those links.
important note: anchor links do not matter, and do not need the slash at the end.

there's another layer to this work which is fixing up the links that come from `GetDocLinkForPulumiType` but ill take that on in a separate pr.

you can view a preview of the docs here:
http://pulumi-docs-origin-pr-8310-e2322762.s3-website.us-west-2.amazonaws.com/registry

the majority of what this is fixing is adding a slash to the end of links on the top-level API docs pages, and the module pages. you can hover over any of those links in a package to confirm they have the slash.

<img width="771" alt="Screen Shot 2022-12-07 at 3 03 11 PM" src="https://user-images.githubusercontent.com/5489125/206315890-c75401e6-669f-42ef-a13c-2bdddb9b8779.png">

Fixes # (issue)

## Checklist

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Service,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: susanev <susan.ra.evans@gmail.com>
  • Loading branch information
bors[bot] and susanev committed Dec 8, 2022
2 parents ef58dcc + 0d336e5 commit 711a3e9
Show file tree
Hide file tree
Showing 46 changed files with 124 additions and 124 deletions.
4 changes: 2 additions & 2 deletions pkg/codegen/docs/gen.go
Expand Up @@ -1846,7 +1846,7 @@ func (mod *modContext) genIndex() indexData {
for _, r := range mod.resources {
name := resourceName(r)
resources = append(resources, indexEntry{
Link: getResourceLink(name),
Link: getResourceLink(name) + "/",
DisplayName: name,
})
}
Expand All @@ -1856,7 +1856,7 @@ func (mod *modContext) genIndex() indexData {
for _, f := range mod.functions {
name := tokenToName(f.Token)
functions = append(functions, indexEntry{
Link: getFunctionLink(name),
Link: getFunctionLink(name) + "/",
DisplayName: strings.Title(name),
})
}
Expand Down
Expand Up @@ -18,7 +18,7 @@ A native Pulumi package for creating and managing Azure resources.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,7 +13,7 @@ Explore the resources and functions of the azure-native.documentdb module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="sqlresourcesqlcontainer" title="SqlResourceSqlContainer"><span class="api-symbol api-symbol--resource"></span>SqlResourceSqlContainer</a></li>
<li><a href="sqlresourcesqlcontainer/" title="SqlResourceSqlContainer"><span class="api-symbol api-symbol--resource"></span>SqlResourceSqlContainer</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,7 +13,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -18,7 +18,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,8 +13,8 @@ Explore the resources and functions of the foo-bar.submodule1 module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="fooencryptedbarclass" title="FOOEncryptedBarClass"><span class="api-symbol api-symbol--resource"></span>FOOEncryptedBarClass</a></li>
<li><a href="moduleresource" title="ModuleResource"><span class="api-symbol api-symbol--resource"></span>ModuleResource</a></li>
<li><a href="fooencryptedbarclass/" title="FOOEncryptedBarClass"><span class="api-symbol api-symbol--resource"></span>FOOEncryptedBarClass</a></li>
<li><a href="moduleresource/" title="ModuleResource"><span class="api-symbol api-symbol--resource"></span>ModuleResource</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -18,7 +18,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,8 +13,8 @@ Explore the resources and functions of the plant.tree/v1 module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="nursery" title="Nursery"><span class="api-symbol api-symbol--resource"></span>Nursery</a></li>
<li><a href="rubbertree" title="RubberTree"><span class="api-symbol api-symbol--resource"></span>RubberTree</a></li>
<li><a href="nursery/" title="Nursery"><span class="api-symbol api-symbol--resource"></span>Nursery</a></li>
<li><a href="rubbertree/" title="RubberTree"><span class="api-symbol api-symbol--resource"></span>RubberTree</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -18,7 +18,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,8 +13,8 @@ Explore the resources and functions of the plant.tree/v1 module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="nursery" title="Nursery"><span class="api-symbol api-symbol--resource"></span>Nursery</a></li>
<li><a href="rubbertree" title="RubberTree"><span class="api-symbol api-symbol--resource"></span>RubberTree</a></li>
<li><a href="nursery/" title="Nursery"><span class="api-symbol api-symbol--resource"></span>Nursery</a></li>
<li><a href="rubbertree/" title="RubberTree"><span class="api-symbol api-symbol--resource"></span>RubberTree</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -18,7 +18,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,7 +13,7 @@ Explore the resources and functions of the example.myModule module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="iamresource" title="IamResource"><span class="api-symbol api-symbol--resource"></span>IamResource</a></li>
<li><a href="iamresource/" title="IamResource"><span class="api-symbol api-symbol--resource"></span>IamResource</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,8 +13,8 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="component" title="Component"><span class="api-symbol api-symbol--resource"></span>Component</a></li>
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="component/" title="Component"><span class="api-symbol api-symbol--resource"></span>Component</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,15 +13,15 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="cat" title="Cat"><span class="api-symbol api-symbol--resource"></span>Cat</a></li>
<li><a href="component" title="Component"><span class="api-symbol api-symbol--resource"></span>Component</a></li>
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="workload" title="Workload"><span class="api-symbol api-symbol--resource"></span>Workload</a></li>
<li><a href="cat/" title="Cat"><span class="api-symbol api-symbol--resource"></span>Cat</a></li>
<li><a href="component/" title="Component"><span class="api-symbol api-symbol--resource"></span>Component</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="workload/" title="Workload"><span class="api-symbol api-symbol--resource"></span>Workload</a></li>
</ul>

<h2 id="functions">Functions</h2>
<ul class="api">
<li><a href="argfunction" title="ArgFunction"><span class="api-symbol api-symbol--function"></span>ArgFunction</a></li>
<li><a href="argfunction/" title="ArgFunction"><span class="api-symbol api-symbol--function"></span>ArgFunction</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,12 +13,12 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="functions">Functions</h2>
<ul class="api">
<li><a href="funcwithsecrets" title="FuncWithSecrets"><span class="api-symbol api-symbol--function"></span>FuncWithSecrets</a></li>
<li><a href="funcwithsecrets/" title="FuncWithSecrets"><span class="api-symbol api-symbol--function"></span>FuncWithSecrets</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
4 changes: 2 additions & 2 deletions pkg/codegen/testing/test/testdata/hyphen-url/docs/_index.md
Expand Up @@ -13,8 +13,8 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="registrygeoreplication" title="RegistryGeoReplication"><span class="api-symbol api-symbol--resource"></span>RegistryGeoReplication</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="registrygeoreplication/" title="RegistryGeoReplication"><span class="api-symbol api-symbol--resource"></span>RegistryGeoReplication</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,9 +13,9 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="resource" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
<li><a href="resourceinput" title="ResourceInput"><span class="api-symbol api-symbol--resource"></span>ResourceInput</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="resource/" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
<li><a href="resourceinput/" title="ResourceInput"><span class="api-symbol api-symbol--resource"></span>ResourceInput</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -18,7 +18,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,7 +13,7 @@ Explore the resources and functions of the foo-bar.deeply/nested/module module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="resource" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
<li><a href="resource/" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -18,7 +18,7 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,7 +13,7 @@ Explore the resources and functions of the foo.nested/module module.

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="resource" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
<li><a href="resource/" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
18 changes: 9 additions & 9 deletions pkg/codegen/testing/test/testdata/other-owned/docs/_index.md
Expand Up @@ -13,19 +13,19 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="barresource" title="BarResource"><span class="api-symbol api-symbol--resource"></span>BarResource</a></li>
<li><a href="fooresource" title="FooResource"><span class="api-symbol api-symbol--resource"></span>FooResource</a></li>
<li><a href="otherresource" title="OtherResource"><span class="api-symbol api-symbol--resource"></span>OtherResource</a></li>
<li><a href="overlayresource" title="OverlayResource"><span class="api-symbol api-symbol--resource"></span>OverlayResource</a></li>
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="resource" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
<li><a href="typeuses" title="TypeUses"><span class="api-symbol api-symbol--resource"></span>TypeUses</a></li>
<li><a href="barresource/" title="BarResource"><span class="api-symbol api-symbol--resource"></span>BarResource</a></li>
<li><a href="fooresource/" title="FooResource"><span class="api-symbol api-symbol--resource"></span>FooResource</a></li>
<li><a href="otherresource/" title="OtherResource"><span class="api-symbol api-symbol--resource"></span>OtherResource</a></li>
<li><a href="overlayresource/" title="OverlayResource"><span class="api-symbol api-symbol--resource"></span>OverlayResource</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="resource/" title="Resource"><span class="api-symbol api-symbol--resource"></span>Resource</a></li>
<li><a href="typeuses/" title="TypeUses"><span class="api-symbol api-symbol--resource"></span>TypeUses</a></li>
</ul>

<h2 id="functions">Functions</h2>
<ul class="api">
<li><a href="argfunction" title="ArgFunction"><span class="api-symbol api-symbol--function"></span>ArgFunction</a></li>
<li><a href="overlayfunction" title="OverlayFunction"><span class="api-symbol api-symbol--function"></span>OverlayFunction</a></li>
<li><a href="argfunction/" title="ArgFunction"><span class="api-symbol api-symbol--function"></span>ArgFunction</a></li>
<li><a href="overlayfunction/" title="OverlayFunction"><span class="api-symbol api-symbol--function"></span>OverlayFunction</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,13 +13,13 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="functions">Functions</h2>
<ul class="api">
<li><a href="listconfigurations" title="ListConfigurations"><span class="api-symbol api-symbol--function"></span>ListConfigurations</a></li>
<li><a href="listproductfamilies" title="ListProductFamilies"><span class="api-symbol api-symbol--function"></span>ListProductFamilies</a></li>
<li><a href="listconfigurations/" title="ListConfigurations"><span class="api-symbol api-symbol--function"></span>ListConfigurations</a></li>
<li><a href="listproductfamilies/" title="ListProductFamilies"><span class="api-symbol api-symbol--function"></span>ListProductFamilies</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
Expand Up @@ -13,13 +13,13 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="functions">Functions</h2>
<ul class="api">
<li><a href="getamiids" title="GetAmiIds"><span class="api-symbol api-symbol--function"></span>GetAmiIds</a></li>
<li><a href="liststorageaccountkeys" title="ListStorageAccountKeys"><span class="api-symbol api-symbol--function"></span>ListStorageAccountKeys</a></li>
<li><a href="getamiids/" title="GetAmiIds"><span class="api-symbol api-symbol--function"></span>GetAmiIds</a></li>
<li><a href="liststorageaccountkeys/" title="ListStorageAccountKeys"><span class="api-symbol api-symbol--function"></span>ListStorageAccountKeys</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down
22 changes: 11 additions & 11 deletions pkg/codegen/testing/test/testdata/output-funcs/docs/_index.md
Expand Up @@ -13,21 +13,21 @@ no_edit_this_page: true

<h2 id="resources">Resources</h2>
<ul class="api">
<li><a href="provider" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
<li><a href="provider/" title="Provider"><span class="api-symbol api-symbol--resource"></span>Provider</a></li>
</ul>

<h2 id="functions">Functions</h2>
<ul class="api">
<li><a href="funcwithalloptionalinputs" title="FuncWithAllOptionalInputs"><span class="api-symbol api-symbol--function"></span>FuncWithAllOptionalInputs</a></li>
<li><a href="funcwithconstinput" title="FuncWithConstInput"><span class="api-symbol api-symbol--function"></span>FuncWithConstInput</a></li>
<li><a href="funcwithdefaultvalue" title="FuncWithDefaultValue"><span class="api-symbol api-symbol--function"></span>FuncWithDefaultValue</a></li>
<li><a href="funcwithdictparam" title="FuncWithDictParam"><span class="api-symbol api-symbol--function"></span>FuncWithDictParam</a></li>
<li><a href="funcwithemptyoutputs" title="FuncWithEmptyOutputs"><span class="api-symbol api-symbol--function"></span>FuncWithEmptyOutputs</a></li>
<li><a href="funcwithlistparam" title="FuncWithListParam"><span class="api-symbol api-symbol--function"></span>FuncWithListParam</a></li>
<li><a href="getbastionshareablelink" title="GetBastionShareableLink"><span class="api-symbol api-symbol--function"></span>GetBastionShareableLink</a></li>
<li><a href="getclientconfig" title="GetClientConfig"><span class="api-symbol api-symbol--function"></span>GetClientConfig</a></li>
<li><a href="getintegrationruntimeobjectmetadatum" title="GetIntegrationRuntimeObjectMetadatum"><span class="api-symbol api-symbol--function"></span>GetIntegrationRuntimeObjectMetadatum</a></li>
<li><a href="liststorageaccountkeys" title="ListStorageAccountKeys"><span class="api-symbol api-symbol--function"></span>ListStorageAccountKeys</a></li>
<li><a href="funcwithalloptionalinputs/" title="FuncWithAllOptionalInputs"><span class="api-symbol api-symbol--function"></span>FuncWithAllOptionalInputs</a></li>
<li><a href="funcwithconstinput/" title="FuncWithConstInput"><span class="api-symbol api-symbol--function"></span>FuncWithConstInput</a></li>
<li><a href="funcwithdefaultvalue/" title="FuncWithDefaultValue"><span class="api-symbol api-symbol--function"></span>FuncWithDefaultValue</a></li>
<li><a href="funcwithdictparam/" title="FuncWithDictParam"><span class="api-symbol api-symbol--function"></span>FuncWithDictParam</a></li>
<li><a href="funcwithemptyoutputs/" title="FuncWithEmptyOutputs"><span class="api-symbol api-symbol--function"></span>FuncWithEmptyOutputs</a></li>
<li><a href="funcwithlistparam/" title="FuncWithListParam"><span class="api-symbol api-symbol--function"></span>FuncWithListParam</a></li>
<li><a href="getbastionshareablelink/" title="GetBastionShareableLink"><span class="api-symbol api-symbol--function"></span>GetBastionShareableLink</a></li>
<li><a href="getclientconfig/" title="GetClientConfig"><span class="api-symbol api-symbol--function"></span>GetClientConfig</a></li>
<li><a href="getintegrationruntimeobjectmetadatum/" title="GetIntegrationRuntimeObjectMetadatum"><span class="api-symbol api-symbol--function"></span>GetIntegrationRuntimeObjectMetadatum</a></li>
<li><a href="liststorageaccountkeys/" title="ListStorageAccountKeys"><span class="api-symbol api-symbol--function"></span>ListStorageAccountKeys</a></li>
</ul>

<h2 id="package-details">Package Details</h2>
Expand Down

0 comments on commit 711a3e9

Please sign in to comment.