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

Make some vaguely useful public docs #3

Open
hawksight opened this issue Nov 19, 2024 · 3 comments
Open

Make some vaguely useful public docs #3

hawksight opened this issue Nov 19, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@hawksight
Copy link
Member

hawksight commented Nov 19, 2024

Before making this public the documentation or README.md should actually reflect how to use this provider and make sense to someone outside of the Venafi / Jetstack world.

  • How to use the provider - instantiate
  • How to create a resource - example
  • If time, try to show all resources maybe.
@hawksight hawksight added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 19, 2024
@aidy aidy mentioned this issue Jan 7, 2025
@aidy aidy added this to the v0.1.0 milestone Jan 24, 2025
@aidy
Copy link
Collaborator

aidy commented Feb 6, 2025

Probably worth mentioning somewhere that this isn't expected to be stable at this point, and people should lock the provider version to avoid breakages.

@aidy
Copy link
Collaborator

aidy commented Feb 10, 2025

@hawksight
Copy link
Member Author

Add the quickstart things in the readme, which is all that's really needed.
All the other actual resources and things, @aidy has already done.

@aidy aidy modified the milestones: v0.1.0, v0.2.0 Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants