-
Notifications
You must be signed in to change notification settings - Fork 120
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
Enable Overview, Installation & Configuration pages to be stored inside the repository #224
Comments
Suggested change from Alex's design above: I think the provider repo README and Registry installation and configuration page serve different purposes: The repo README should center around developers working on the provider code itself. The installation and configuration doc is for end users trying to use the provider. Now that we have the Registry, the Registry is the primary entrypoint for users of a provider and I don't expect that most folks visiting the GH repo for the provider are looking for end-user information, so I suggest that we:
The Snowflake registry page refers users to the provider repo README for the full list of config options, and I think that we want to center the registry in the user experience rather than directing them elsewhere. |
This is already possible today, |
Cannot close issue:
Please fix these problems and try again. |
I have opened follow-up issues in each of our boilerplate repos. |
Hello!
Issue details
Today, hand-authored Overview and Installation & Configuration pages for a Pulumi Package are stored in https://github.com/pulumi/registry. As part of #222 and in preparation for #206, we should:
docs/installation-configuration.md
docs/installation-configuration.md
is blankThe text was updated successfully, but these errors were encountered: