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

Remaining Coverage Gaps in Resource Docs #3528

Open
3 of 7 tasks
lukehoban opened this issue Jun 9, 2020 · 0 comments
Open
3 of 7 tasks

Remaining Coverage Gaps in Resource Docs #3528

lukehoban opened this issue Jun 9, 2020 · 0 comments
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features

Comments

@lukehoban
Copy link
Contributor

lukehoban commented Jun 9, 2020

The new resource docs provide a high quality cross-language experience for the majority of Pulumi APIs. However, they have some coverage gaps that mean they do not present the full API, which can be misleading, leads to inconsistency, and increases the dependence on language-specific API docs.

Known coverage gaps:

We might be able to address some of these with docs "overlays" as in https://github.com/pulumi/docs/blob/master/tools/resourcedocsgen/overlays/kubernetes/overlays.json. But where possible, we should aim to generalize our schema to support expressing these concepts so they can be authored and maintained as part of the package itself.

@susanev susanev added the kind/enhancement Improvements or new features label Apr 2, 2022
@susanev susanev added the area/docs Improvements or additions to documentation label Apr 30, 2023
@cnunciato cnunciato moved this to 🧳 Backlog in Docs 📚 Jul 21, 2023
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/enhancement Improvements or new features
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

2 participants