Categorize the resources in the documentation to spot them easily
ashishth09 opened this issue · 5 comments
- We can have one data source section without calling it Infrastructure specifically.
- We would require three sections for non data source resources:
- Container/Cluster Resources
- Infrastructure Resources
- Cloud Foundry Resources
Reference - https://ibm-bluemix.github.io/tf-ibm-docs/tf-v0.9.3-ibm-provider-v0.2.1/
I agree with @ashishth09, we can have the following categories
- IBM Cloud Provider
- Data Sources
- cf_account
- cf_org
and so on..
- Cloud Foundry Resources
- cf_service_instance
- cf_service_key
- Container Resources
- cs_cluster
- cs_cluster_bind_service
- Infrastructure Resources
- infra_bare_metal
- infra_basic_monitor
and so on..
@albee-jhoney @ashishth09 sure thing. I originally modelled it after https://github.com/IBM-Bluemix/terraform/blob/provider/ibm-cloud/website/source/layouts/ibmcloud.erb#L13 -- and infact I was originally importing this template (then doing a bunch of find and replace on it to get it to work w/ the new format) but then abadon it.
I'll take a look and see what I can do :)
//cc @davetropeano
Yes, we should be able to do that -- good idea and it aligns with some of the other providers.
@albee-jhoney @ashishth09 Dave is reviewing now, but I've got these changes in. Have a look at one of the versions that has cs and cf resources such as https://ibm-bluemix.github.io/tf-ibm-docs/tf-v0.9.3-ibm-provider-v0.2.1/ (currently landing page is just infra for schmatics version, but this will change monday when they update to latest provider)
edit: Please close if you find this sufficient. As we add more "categories" you'll need to coordinate with me to get them added, or always always feel free to make a PR to the docs repo: https://github.com/IBM-Bluemix/tf-ibm-docs
@ckelner , this looks good 👍, thanks. Just for the completeness sake, I will update the basic layout(erb) in this repository as well.