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

adding slash to gen.go links for seo reasons #11569

Merged
merged 4 commits into from Dec 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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) + "/",
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm tempted to say this should be some kind of conditional that checks whether there's already a trailing slash (defense in depth and all that), and that should probably occur within the getResourceLink function.

Just my 2c. 🪙 It's late here, otherwise I'd offer a more concrete suggestion, apologies! I'll revisit tomorrow during work hours when I triage my notifications.

Copy link
Contributor Author

@susanev susanev Dec 8, 2022

Choose a reason for hiding this comment

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

would you be okay with that change happening after this pr lands? I'm happy to revisit this in more detail later on if you'd be up for pairing.

right now none of the resources and function links end in slashes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think there's prolly some other issues in this file as well if we want to go with your suggested approach, specifically with anchors getting the octothorpe added in this file.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good to me!

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