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

Write a guide that describes how to write (multi-code) examples in the docs #6775

Open
iwahbe opened this issue Mar 3, 2025 · 0 comments
Open
Assignees
Labels
area/docs Hand-written documentation. For api docs, see area/api-docs. kind/task Work that's part of an ongoing epic

Comments

@iwahbe
Copy link
Member

iwahbe commented Mar 3, 2025

We should write down how we currently process code blocks in schemas.

  • This should mention how the registry processes <!--Start PulumiCodeChooser --> and {{% examples %}}.
  • This should also mention how this interacts with SDK generation, since they do something to strip out non-appropriate code blocks.
  • The guide is a “state of the world”, but not intended for external consumption.
  • This should be a step before getting us to a better state on docs publishing.

We intend to put together a more intentional way to write multi-language docs (pulumi/pulumi#16099).

@pulumi-bot pulumi-bot added the needs-triage Needs attention from the triage team label Mar 3, 2025
@danielrbradley danielrbradley added area/docs Hand-written documentation. For api docs, see area/api-docs. and removed needs-triage Needs attention from the triage team labels Mar 6, 2025
@mjeffryes mjeffryes added the kind/task Work that's part of an ongoing epic label Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Hand-written documentation. For api docs, see area/api-docs. kind/task Work that's part of an ongoing epic
Projects
None yet
Development

No branches or pull requests

5 participants