-
Notifications
You must be signed in to change notification settings - Fork 122
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
Make docs contribution more flexible #3391
Comments
cnunciato
added a commit
to cnunciato/pulumi-ovh
that referenced
this issue
Jan 4, 2024
The link we have now points to a page that doesn't exist. This updates the link to point to the doc here in the repository, as we don't yet have support for third-party how-to guides. (That's tracked generally in pulumi/registry#3391.)
scraly
pushed a commit
to ovh/pulumi-ovh
that referenced
this issue
Jan 4, 2024
The link we have now points to a page that doesn't exist. This updates the link to point to the doc here in the repository, as we don't yet have support for third-party how-to guides. (That's tracked generally in pulumi/registry#3391.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Today, we expect package authors to craft Hugo-specific Markdown files, named in a very specific way and containing specific frontmatter fields, to comprise their packages documentation.
This is both too restrictive (authors only get two docs -- one overview page and one install page) and too implementation-specific (authors shouldn't have to deal with the esoteric details of Hugo or whatever other platform we're using in order to ship their packages, nor should we expect them to come up with page titles, meta descriptions, etc., for us).
Instead, we should allow authors to submit plain GitHub-flavored Markdown files for their overview and install docs. Moreover, we should also provide some way for authors to provide additional free-form pages (e.g., how-to guides, upgrade/migration guides) to help their users address common scenarios.
The text was updated successfully, but these errors were encountered: