-
Notifications
You must be signed in to change notification settings - Fork 258
Description
Problem description
All the links in the table on https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/policy/#md:languages are broken (404). The build status badge at the top is also broken.
Root Cause
The broken links are in the language comparison table generated by TypeDoc. Specifically:
Location: /static-prebuilt/docs/reference/pkg/nodejs/pulumi/policy/index.html
Broken Links:
- Line 26 (TypeScript):
<a href="./sdk/nodejs">TypeScript</a>→ points to non-existent./sdk/nodejs/ - Line 31 (JavaScript):
<a href="./sdk/nodejs">JavaScript</a>→ points to non-existent./sdk/nodejs/ - Line 36 (Python):
<a href="./sdk/python">Python</a>→ points to non-existent./sdk/python/
These relative paths don't exist in the policy documentation structure. The correct targets should be:
- TypeScript/JavaScript: Current page (remove links or use
#/./) - Python:
/docs/reference/pkg/python/pulumi_policy/(relative:../../../python/pulumi_policy/)
Source of the Issue
The HTML is auto-generated by TypeDoc from the pulumi-policy repository, specifically from:
pulumi-policy/sdk/nodejs/policy/README.md
The source markdown likely contains:
| [TypeScript](./sdk/nodejs) |
| [JavaScript](./sdk/nodejs) |
| [Python](./sdk/python) |Fix Required in pulumi-policy Repository
Update the README.md table in pulumi-policy/sdk/nodejs/policy/README.md:
Change from:
| [TypeScript](./sdk/nodejs) |
| [JavaScript](./sdk/nodejs) |
| [Python](./sdk/python) |Change to:
| TypeScript |
| JavaScript |
| [Python](/docs/reference/pkg/python/pulumi_policy/) |Or alternatively use relative paths for Python: ../../../python/pulumi_policy/
After fixing the source, regenerate the TypeDoc documentation by running make generate in the pulumi/docs repository.
Investigation details
- This page appears not to have changed since 2024, so this may be a longstanding issue that has just surfaced again due to recent attention.
- The TypeScript documentation wiring for this area is unclear and may be misconfigured.
- Last known changes to this area were by @julienp, paging for context/help.
Affected product version(s)
- Documentation for Policy SDK, nodejs package reference