Merge pull request #342 from MadalinaM22/job-config-history-documenta…

…tion

Update README.md for Job Configuration History Plugin

README.md

@@ -1,41 +1,53 @@
-Job Configuration History Plugin
-==============================
+# Job Configuration History Plugin
+
 [![Build Status](https://ci.jenkins.io/buildStatus/icon?job=Plugins%2Fjob-config-history-plugin%2Fmaster)](https://ci.jenkins.io/job/plugins/job/job-config-history-plugin/job/master/)
 [![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/jobConfigHistory.svg)](https://plugins.jenkins.io/jobConfigHistory)
 [![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/jobConfigHistory.svg?color=blue)](https://plugins.jenkins.io/jobConfigHistory)
 [![Contributors](https://img.shields.io/github/contributors/jenkinsci/jobConfigHistory-plugin.svg)](https://github.com/jenkinsci/job-config-history-plugin/graphs/contributors)
 
-Saves copies of all job and system configurations.
+This plugin saves copies of all job and system configurations, in order to maintain the history of what has changed and who made the changes.
 
-This plugin saves **a copy of the configuration file** of jobs and agents (`config.xml`) for every change made and of the system configuration (`<config-name>.xml`).
-You can also see what changes have been made by which user if you configured a security policy.
-
-It is also possible to get a **side-by-side view** of the differences between two configurations and to restore an old version of a job's configuration. (The latter is only available for jobs, not for system changes.)
-However, if you restore an older version of the config file and the new version contains fields that were not present in the older version, the restored version will still contain these fields, although they were not present in the original.
-
-The plugin also provides an **overview page** of all changes. You can find it under `<jenkins_url>/jobConfigHistory` or reach it via links in the sidepanel of the main and the system configuration pages.
-The overview page initially only lists system configuration changes (for performance reasons), but there are links to view either all job configuration histories or just the deleted jobs or all kinds of configuration history entries together (which may take some time to load, depending on the number of jobs in your instance).
+<!-- TOC -->
+* [Job Configuration History Plugin](#job-configuration-history-plugin)
+  * [Documentation](#documentation)
+    * [Job Config History Revision Overview](#job-config-history-revision-overview)
+    * [Job Diff Side-By-Side View](#job-diff-side-by-side-view)
+    * [Config Overview Page](#config-overview-page)
+  * [Interdependencies with other Plugins or Excluding config path parts such as jobs, folders](#interdependencies-with-other-plugins-or-excluding-config-path-parts-such-as-jobs-folders)
+  * [Open Issues](#open-issues)
+  * [Changelog](#changelog)
+  * [Notes](#notes)
+<!-- TOC -->
 
 ------------------------------------------------------------------------
 
-# Pictures
+## Documentation
 
 #### Job Config History Revision Overview
 
+This plugin saves **a copy of the configuration file** of jobs and agents (`config.xml`) for every change made and of the system configuration (`<config-name>.xml`).
+You can also see what changes have been made by which user if you configured a security policy.
+
 ![](docs/img/Job_Config_History_Revision_Overview.png)
 
 #### Job Diff Side-By-Side View
 
+It is also possible to get a **side-by-side view** of the differences between two configurations and to restore an old version of a job's configuration. (The latter is only available for jobs, not for system changes.)
+However, if you restore an older version of the config file and the new version contains fields that were not present in the older version, the restored version will still contain these fields, although they were not present in the original.
+
 ![](docs/img/Job_Diff_Side-By-Side_View.png) 
 
 #### Config Overview Page
 
+The plugin also provides an **overview page** of all changes. You can find it under `<jenkins_url>/jobConfigHistory` or reach it via links in the sidepanel of the main and the system configuration pages.
+The overview page initially only lists system configuration changes (for performance reasons), but there are links to view either all job configuration histories or just the deleted jobs or all kinds of configuration history entries together (which may take some time to load, depending on the number of jobs in your instance).
+
 ![](docs/img/Config_Overview_Page.png)
 
 
 ------------------------------------------------------------------------
 
-# Interdependencies with other Plugins/ Excluding config path parts (jobs, folders, ...)
+## Interdependencies with other Plugins or Excluding config path parts such as jobs, folders
 
 If you use other plugins, that are (automatically) changing the configuration, you might end up with a lot of unwanted change detections.
 
@@ -53,20 +65,20 @@ If you use this plugin together with the [Cluster Statistics Plugin](https://plu
 
 ------------------------------------------------------------------------
 
-# Open Issues
+## Open Issues
 
 * See [open issues](https://issues.jenkins.io/browse/JENKINS-66956?jql=component%20%3D%20jobconfighistory-plugin) on issues.jenkins-ci.org.
 
 ------------------------------------------------------------------------
 
-# Changelog
+## Changelog
 
 See
 [Changelog](https://github.com/jenkinsci/job-config-history-plugin/releases)
 on Github.
 
 ------------------------------------------------------------------------
-# Notes
+## Notes
 
 * This plugin uses *highlight.js* for syntax highlighting (code and diffs). See
     + [github](https://github.com/highlightjs/highlight.js/)