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

Generate a JSON representation of docs content #12244

Closed
cnunciato opened this issue Jul 10, 2024 · 1 comment · Fixed by #12004
Closed

Generate a JSON representation of docs content #12244

cnunciato opened this issue Jul 10, 2024 · 1 comment · Fixed by #12004
Assignees
Labels
area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user resolution/fixed This issue was fixed
Milestone

Comments

@cnunciato
Copy link
Member

cnunciato commented Jul 10, 2024

For easier consumption by internal services (e.g., Pulumi Copilot), we should generate a JSON document on every deployment containing all of our docs content, ideally in Markdown and indexed by URL path. For example:

[
    {
        "path": "/docs/get-started/index.html",
        "title": "Get Started with Pulumi | Pulumi Docs",
        "h1": "Get started with Pulumi",
        "main": {
            "innerHTML": "<p>Pulumi is an <a href=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/what-is/what-is-infrastructure-as-code></a>infrastructure as code platform [...]",
            "textContent": "Pulumi is an infrastructure as code platform [...]",
            "markdown": "Pulumi is an [](/what-is/what-is-infrastructure-as-code)infrastructure as code platform [...]"
        }
    },
    // ...
]
@cnunciato cnunciato self-assigned this Jul 10, 2024
@cnunciato cnunciato added area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user labels Jul 10, 2024
@cnunciato cnunciato added this to the 0.107 milestone Jul 10, 2024
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Jul 10, 2024
@cnunciato cnunciato added resolution/fixed This issue was fixed and removed needs-triage Needs attention from the triage team labels Jul 10, 2024
@cnunciato
Copy link
Member Author

Fixed via #12004.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/engineering Work that is not visible to an external user resolution/fixed This issue was fixed
Projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

1 participant