Update documentation for TF registry

kingsoftgames · Aug 9, 2020 · 0b07363 · 0b07363
1 parent c938753
commit 0b07363
Show file tree

Hide file tree

Showing 8 changed files with 6 additions and 284 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/index.md b/docs/index.md
@@ -1,16 +1,7 @@
----
-title: "Home"
-description: |-
-  The Jenkins provider is used to interact with the Jenkins API. The provider needs to be configured with the proper credentials before it can be used.
----
+# Jenkins Provider
 
 The Jenkins provider is used to interact with the Jenkins API. The provider needs to be configured with the proper credentials before it can be used.
 
-## Available Resources
-
-* [jenkins_folder](resource_jenkins_folder.md)
-* [jenkins_job](resource_jenkins_job.md)
-
 ## Example Usage
 
 ```hcl

diff --git a/docs/makefile b/docs/makefile
diff --git a/docs/resource_jenkins_folder.md → docs/resources/folder.md b/docs/resource_jenkins_folder.md → docs/resources/folder.md
@@ -1,9 +1,8 @@
----
----
+# jenkins_folder Resource
 
-# jenkins_folder
+Manages a folder within Jenkins.
 
-Manages a folder within Jenkins. The Jenkins installation that uses this resource is expected to have the [Cloudbees Folders Plugin](https://plugins.jenkins.io/cloudbees-folder) installed in their system.
+~> The Jenkins installation that uses this resource is expected to have the [Cloudbees Folders Plugin](https://plugins.jenkins.io/cloudbees-folder) installed in their system.
 
 ## Example Usage
 
@@ -12,7 +11,7 @@ resource jenkins_folder example {
     name = "folder-name"
 }
 
-resource jenkins_folder example-child {
+resource jenkins_folder example_child {
     name = "${jenkins_folder.example.name}/child-name"
 }
 ```

diff --git a/docs/resource_jenkins_job.md → docs/resources/job.md b/docs/resource_jenkins_job.md → docs/resources/job.md
@@ -1,7 +1,4 @@
----
----
-
-# jenkins_job
+# jenkins_job Resource
 
 Manages a job within Jenkins.