Merge pull request jenkinsci#9 from abayer/add-categories

Simple categorization of examples.
lewisit · Dec 16, 2015 · 41b0312 · 41b0312
2 parents f5bbf43 + 459651a
commit 41b0312
Show file tree

Hide file tree

Showing 19 changed files with 18 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,17 @@
 # Introduction
 
-This repository is a home for snippets, tips and tricks and examples
-of scripting for the [Jenkins Workflow plugin](https://github.com/jenkinsci/workflow-plugin/blob/master/README.md).
+This repository is a home for snippets, tips and tricks and examples of scripting for the [Jenkins Workflow plugin](https://github.com/jenkinsci/workflow-plugin/blob/master/README.md).
 
 # Layout
 
-Please put your script into its own directory, with a README.md file
-included explaining what your script does or shows. Make sure your
-script is commented so that others can understand how it works, why it
-works, etc.
+The repository is broken up into four directories currently:
+
+* *workflow-examples* - for general Workflow examples.
+* *global-library-examples* - for examples of how to write and use the global library on a Jenkins master.
+* *jenkinsfile-examples* - for examples of using `Jenkinsfile`s checked into repositories.
+* *docs* - for documentation, guides and other non-code content.
+
+Please put your script into its own directory under the appropriate directory above, with a README.md file included explaining what your script does or shows. Make sure your script is commented so that others can understand how it works, why it works, etc.
 
 # License
 

diff --git a/BEST_PRACTICES.md → docs/BEST_PRACTICES.md b/BEST_PRACTICES.md → docs/BEST_PRACTICES.md
diff --git a/global-library-examples/README.md b/global-library-examples/README.md
@@ -0,0 +1,3 @@
+# Global library examples
+
+This directory contains examples of how to extend Workflow using the global library on your Jenkins master.
diff --git a/jenkinsfile-examples/README.md b/jenkinsfile-examples/README.md
@@ -0,0 +1,3 @@
+# Jenkinsfile examples
+
+This directory contains example Jenkinsfiles, which are used with the Multibranch Workflow functionality, or the Workflow script from SCM functionality.
diff --git a/workflow-examples/README.md b/workflow-examples/README.md
@@ -0,0 +1,3 @@
+# Workflow examples
+
+This directory contains various Worklow examples, showing how to use specific plugins, how the Workflow DSL works, and more.
diff --git a/get-build-cause/README.md → workflow-examples/get-build-cause/README.md b/get-build-cause/README.md → workflow-examples/get-build-cause/README.md
diff --git a/get-build-cause/getBuildCause.groovy → ...ples/get-build-cause/getBuildCause.groovy b/get-build-cause/getBuildCause.groovy → ...ples/get-build-cause/getBuildCause.groovy
diff --git a/gitcommit/README.md → workflow-examples/gitcommit/README.md b/gitcommit/README.md → workflow-examples/gitcommit/README.md
diff --git a/gitcommit/gitcommit.groovy → workflow-examples/gitcommit/gitcommit.groovy b/gitcommit/gitcommit.groovy → workflow-examples/gitcommit/gitcommit.groovy
diff --git a/parallel-from-list/README.md → ...low-examples/parallel-from-list/README.md b/parallel-from-list/README.md → ...low-examples/parallel-from-list/README.md
diff --git a/parallel-from-list/parallelFromList.groovy → ...arallel-from-list/parallelFromList.groovy b/parallel-from-list/parallelFromList.groovy → ...arallel-from-list/parallelFromList.groovy
diff --git a/push-git-repo/README.md → workflow-examples/push-git-repo/README.md b/push-git-repo/README.md → workflow-examples/push-git-repo/README.md
diff --git a/push-git-repo/pushGitRepo.Groovy → ...examples/push-git-repo/pushGitRepo.Groovy b/push-git-repo/pushGitRepo.Groovy → ...examples/push-git-repo/pushGitRepo.Groovy
diff --git a/slacknotify/README.md → workflow-examples/slacknotify/README.md b/slacknotify/README.md → workflow-examples/slacknotify/README.md
diff --git a/slacknotify/slackNotify.groovy → ...w-examples/slacknotify/slackNotify.groovy b/slacknotify/slackNotify.groovy → ...w-examples/slacknotify/slackNotify.groovy
diff --git a/timestamper-wrapper/README.md → ...ow-examples/timestamper-wrapper/README.md b/timestamper-wrapper/README.md → ...ow-examples/timestamper-wrapper/README.md
diff --git a/...stamper-wrapper/timestamperWrapper.groovy → ...stamper-wrapper/timestamperWrapper.groovy b/...stamper-wrapper/timestamperWrapper.groovy → ...stamper-wrapper/timestamperWrapper.groovy
diff --git a/unstash-different-dir/README.md → ...-examples/unstash-different-dir/README.md b/unstash-different-dir/README.md → ...-examples/unstash-different-dir/README.md
diff --git a/...-different-dir/unstashDifferentDir.groovy → ...-different-dir/unstashDifferentDir.groovy b/...-different-dir/unstashDifferentDir.groovy → ...-different-dir/unstashDifferentDir.groovy
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Global library examples

		This directory contains examples of how to extend Workflow using the global library on your Jenkins master.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Jenkinsfile examples

		This directory contains example Jenkinsfiles, which are used with the Multibranch Workflow functionality, or the Workflow script from SCM functionality.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Workflow examples

		This directory contains various Worklow examples, showing how to use specific plugins, how the Workflow DSL works, and more.