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

Build and/or document a way to manually provide documentation for a package #1491

Open
mrgrain opened this issue Oct 7, 2024 · 0 comments
Open

Comments

@mrgrain
Copy link
Contributor

mrgrain commented Oct 7, 2024

Description

When processing a package fails (i.e. during transliteration), the respective per-language documentation will be missing for the end-user. However in certain situations it might still be easily possible to generate this documentation on a local machine (e.g. using a different bug-free version of jsii-docgen/jsii-rosetta, making a minor local change to the package in question etc).

In this situation it might be preferable to have a way to provide the documentation for a package out-of-band, while the issue is fixed properly.

Use Case

We recently had an issue where language docs of aws-cdk-lib did not build due to an underlying issue. However locally generating the docs was still possible. If we had this feature, we could have mitigated the impact sooner.

If a high-impact package had an error that prevented processing for a good reason, but would be easy to fix in a local build we could use this mechanism to provide docs any way. Otherwise the package would have to release a new version but the affected version would never be able to receive a fix.

Other information

This might already be possible with respective bucket access. We might just need to provide documentation and a script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant