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

feat(docs): fix doc generation #247

Merged
merged 2 commits into from
Aug 2, 2023

Conversation

haarchri
Copy link
Contributor

@haarchri haarchri commented Aug 1, 2023

Description of your changes

follow up for
#238
and revert from
#244

the page_title is different for provider-vault then to other providers
page_title: "Vault: vault_ad_secret_backend_library resource"
for that reason i added a small code path to make the example generation working

Fixes #

I have:

  • Read and followed Crossplane's contribution process.
  • Run make reviewable to ensure this PR is ready for review.
  • Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

rerun make generate in upbound official-providers for aws, gcp and azure

crossplane-contrib/provider-upjet-aws#806 (we have a small diff in config/provider-metadata.yaml because some markdown pages using ' instead of " and the new version fixed this)
crossplane-contrib/provider-upjet-gcp#347
crossplane-contrib/provider-upjet-azure#502
crossplane-contrib/provider-pagerduty#18 (we have a small diff in config/provider-metadata.yaml because some markdown pages using ' instead of " and the new version fixed this)

https://github.com/upbound/provider-vault/pull/7/files
here we see that all examples now generated:

ls -ali examples-generated 
total 0
6199735 drwxr-x---@ 36 haarchri  staff  1152 Aug  1 18:47 .
5427646 drwxr-xr-x  28 haarchri  staff   896 Aug  1 18:47 ..
6199811 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 ad
6199849 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 alicloud
6199757 drwxr-x---@  5 haarchri  staff   160 Aug  1 18:47 approle
6199749 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 audit
6199865 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 auth
6199745 drwxr-x---@ 13 haarchri  staff   416 Aug  1 18:47 aws
6199773 drwxr-x---@  6 haarchri  staff   192 Aug  1 18:47 azure
6199798 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 consul
6199817 drwxr-x---@  6 haarchri  staff   192 Aug  1 18:47 database
6199845 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 egp
6199800 drwxr-x---@  7 haarchri  staff   224 Aug  1 18:47 gcp
6199842 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 generic
6199793 drwxr-x---@  5 haarchri  staff   160 Aug  1 18:47 github
6199761 drwxr-x---@ 22 haarchri  staff   704 Aug  1 18:47 identity
6199823 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 jwt
6199743 drwxr-x---@  5 haarchri  staff   160 Aug  1 18:47 kmip
6199826 drwxr-x---@  6 haarchri  staff   192 Aug  1 18:47 kubernetes
6199765 drwxr-x---@  5 haarchri  staff   160 Aug  1 18:47 kv
6199809 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 managed
6199747 drwxr-x---@  6 haarchri  staff   192 Aug  1 18:47 mfa
6199795 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 mongodbatlas
6199740 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 nomad
6199769 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 password
6199736 drwxr-x---@ 11 haarchri  staff   352 Aug  1 18:47 pki
6199771 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 quota
6199753 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 rabbitmq
6199738 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 raft
6199755 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 rgp
6199759 drwxr-x---@  4 haarchri  staff   128 Aug  1 18:47 ssh
6199763 drwxr-x---@  5 haarchri  staff   160 Aug  1 18:47 terraform
6199791 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 token
6199767 drwxr-x---@  6 haarchri  staff   192 Aug  1 18:47 transform
6199782 drwxr-x---@  3 haarchri  staff    96 Aug  1 18:47 transit
6199751 drwxr-x---@  7 haarchri  staff   224 Aug  1 18:47 vault

Signed-off-by: Christopher Haar <christopher.haar@upbound.io>
Signed-off-by: Christopher Haar <christopher.haar@upbound.io>
Copy link
Collaborator

@ulucinar ulucinar left a comment

Choose a reason for hiding this comment

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

Thanks @haarchri for making the example generation pipeline applicable to more providers and for validating it for the official providers. Very much appreciated.

@haarchri haarchri merged commit caa74d2 into crossplane:main Aug 2, 2023
4 checks passed
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