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

update package details anchors #11893

Merged
merged 6 commits into from Jan 19, 2023
Merged

update package details anchors #11893

merged 6 commits into from Jan 19, 2023

Conversation

sean1588
Copy link
Member

@sean1588 sean1588 commented Jan 17, 2023

fixes: pulumi/registry#1819

OK taking this for round 2. The first PR to make this change I ended up reverting because there were some pages (the function pages and module pages) still being generated with empty href tags.

I have addressed this and updated the change to define the DisplayName and RepositoryName props on the packageDetails struct for the individual module pages and function pages. This updates the repository anchor in the Package Details section of the api docs pages. I updated it to display <package name> repository for the anchor text in place of the url that was previously shown there.

image

So now this will show the following on the following pages:

  1. the root index package pages
  2. the module pages
  3. the resource pages
  4. the function pages

@pulumi-bot
Copy link
Contributor

Changelog

[uncommitted] (2023-01-17)

@sean1588 sean1588 added the impact/no-changelog-required This issue doesn't require a CHANGELOG update label Jan 17, 2023
Copy link
Contributor

@RobbieMcKinstry RobbieMcKinstry left a comment

Choose a reason for hiding this comment

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

The file count was misleading. This was easy to review!

@sean1588
Copy link
Member Author

haha yeah most of the diff is the newly generated test data. thanks @RobbieMcKinstry

@sean1588
Copy link
Member Author

bors try

bors bot added a commit that referenced this pull request Jan 19, 2023
@sean1588
Copy link
Member Author

bors r+

@bors
Copy link
Contributor

bors bot commented Jan 19, 2023

try

Build failed:

@bors
Copy link
Contributor

bors bot commented Jan 19, 2023

Build succeeded:

@bors bors bot merged commit 2ef87d8 into master Jan 19, 2023
@bors bors bot deleted the sean/update-pkg-details-anchors branch January 19, 2023 23:47
abhinav added a commit to pulumi/pulumi-java that referenced this pull request Feb 13, 2023
These were added recently in pulumi/pulumi#11996 and pulumi/pulumi#11893.
pulumi-java does not yet pass these tests.
abhinav pushed a commit to pulumi/pulumi-java that referenced this pull request Feb 13, 2023
Bumps [github.com/pulumi/pulumi/pkg/v3](https://github.com/pulumi/pulumi) from 3.49.0 to 3.54.0.

To account for changes since 3.49:

- Skips two more codegen tests. These were added recently (pulumi/pulumi#11996 and pulumi/pulumi#11893) and the Java SDK does not pass these yet.
- Update generated code—a function without a result doesn't get a Result type anymore (pulumi/pulumi#11596).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/no-changelog-required This issue doesn't require a CHANGELOG update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

links without anchor text
3 participants