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

[Non code Contribution] Auto-generate cloud resource reference documentation #511

Open
1 of 3 tasks
BinaryHB0916 opened this issue Feb 15, 2022 · 1 comment
Open
1 of 3 tasks
Labels
good first issue Good for newcomers

Comments

@BinaryHB0916
Copy link
Member

BinaryHB0916 commented Feb 15, 2022

KubeVela is a powerful CI/CD platform that let you import and manage all kinds of cloud resources from almost every cloud vendor. To all these cloud resources, a clear doc of each that guides us to smoothly use it is necessary and very friendly to the community.

Regarding tons of cloud resources adding into the KubeVela platform, maintain their accordingly docs is a major task. It'll be landed even more faster with the help from you. Thanks for contribution!

Missing cloud resources doc (up to date of 2020/02/25, KEEP UPDATING):

  • Azure MariaDB, example, adding up the missing ones at below
  • Azure/GCP/AWS/TencentCloud/AlibabaCloud XXX
  • ....

How-to in simply using Vela CLI(Make Azure MariaDB as a guide):

  1. run a Vela CLI command vela addon enable terraform-azure that installs Azure Terraform provider for you
  2. using vela def list to check the official name of MariaDB
    image
  3. using vela def doc-gen azure-database-mariadb -n vela-system to generate the doc
  4. you'll find 2 azure-database-mariadb.md files that are in Chinese and English at the current directory
  5. go submitting a PR to Supported Cloud Resource list
  6. comment in this issue to let the community know and Hooray!
@BinaryHB0916 BinaryHB0916 added the good first issue Good for newcomers label Feb 15, 2022
@BinaryHB0916 BinaryHB0916 changed the title [Need Help] Auto-generate cloud resource reference documentation [Non code Contribution] Auto-generate cloud resource reference documentation Mar 10, 2022
@yashvardhanmishra
Copy link

I want to work on this , Could you please assign this issue to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants