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

SUP-1293 Generate docs from code #397

Conversation

jradtilbrook
Copy link
Contributor

@jradtilbrook jradtilbrook commented Sep 7, 2023

PR checklist:

  • docs/ updated
    • add import examples
    • update examples with comments to explain them
  • tests added
  • an example added to examples/ (useful to demo new field/resource)
  • CHANGELOG.md updated with pending release information

@jradtilbrook jradtilbrook force-pushed the sup-1293-spike-generate-documentation-for-provider-from-the-attribute branch 2 times, most recently from c551eb6 to 4781eb3 Compare September 11, 2023 01:35
@jradtilbrook jradtilbrook force-pushed the sup-1293-spike-generate-documentation-for-provider-from-the-attribute branch from 4781eb3 to 5e18d2a Compare September 11, 2023 01:35
@jradtilbrook
Copy link
Contributor Author

jradtilbrook commented Sep 12, 2023

Honestly, there isnt much point reviewing this! 😰

Everything under docs/ is generated so that can basically be ignored. The changes to the rest is the actual content. But its also hard to review it.

I'm wondering if we merge this, create a release like 1.0.0-docs.beta or something. So we can check it out on terraform registry and see it rendered and review it there

@jradtilbrook jradtilbrook marked this pull request as ready for review September 12, 2023 01:28
@james2791 james2791 self-requested a review September 12, 2023 01:52
james2791
james2791 previously approved these changes Sep 12, 2023
Copy link
Contributor

@james2791 james2791 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@jradtilbrook
Copy link
Contributor Author

Ive created this registry off of this branch https://registry.terraform.io/providers/jradtilbrook/greatest/latest (I forked the repo).

So we can view the docs there and review things from the rendered output.

I also tested the semver stuff. The registry shows the latest release docs but installing it is not possible unless you specify the exact version. Eg 2.0.0-beta will install, but ~> 2.0 will not. And that is what we want for the v1 release

james2791
james2791 previously approved these changes Sep 12, 2023
…te-documentation-for-provider-from-the-attribute
@jradtilbrook jradtilbrook merged commit 57604eb into main Sep 12, 2023
@jradtilbrook jradtilbrook deleted the sup-1293-spike-generate-documentation-for-provider-from-the-attribute branch September 12, 2023 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants