[icinga-checkins] icinga.org: icingaweb2-module-director/master: doc: add fixed ids to all main headers

git at icinga.org git at icinga.org
Thu Jun 23 17:09:28 CEST 2016


Module: icingaweb2-module-director
Branch: master
Commit: 3165b44dbe5db21a888a0c606e9bb2c4251ab67b
URL:    https://git.icinga.org/?p=icingaweb2-module-director.git;a=commit;h=3165b44dbe5db21a888a0c606e9bb2c4251ab67b

Author: Thomas Gelf <thomas at gelf.net>
Date:   Thu Jun 23 17:09:06 2016 +0200

doc: add fixed ids to all main headers

---

 doc/01-Introduction.md              |    4 ++--
 doc/02-Installation.md              |    4 ++--
 doc/03-Automation.md                |    2 +-
 doc/04-Getting-started.md           |    4 ++--
 doc/05-Upgrading.md                 |   27 +++++++++++++++------------
 doc/10-How-it-works.md              |    4 ++--
 doc/12-Handling-custom-variables.md |    4 ++--
 doc/60-CLI.md                       |    4 ++--
 doc/70-Import-and-Sync.md           |    4 ++--
 doc/70-REST-API.md                  |    4 ++--
 doc/79-Jobs.md                      |    4 ++--
 doc/80-FAQ.md                       |    4 ++--
 doc/91-Want-more.md                 |    4 ++--
 13 files changed, 38 insertions(+), 35 deletions(-)

diff --git a/doc/01-Introduction.md b/doc/01-Introduction.md
index f09d1c9..4242054 100644
--- a/doc/01-Introduction.md
+++ b/doc/01-Introduction.md
@@ -1,5 +1,5 @@
-Introduction
-============
+<a id="Introduction"></a>Introduction
+=====================================
 
 Welcome to the Icinga Director, the bleeding edge configuration tool for
 Icinga 2! Developed as an Icinga Web 2 module it aims to be your new
diff --git a/doc/02-Installation.md b/doc/02-Installation.md
index 78d5887..598bf61 100644
--- a/doc/02-Installation.md
+++ b/doc/02-Installation.md
@@ -1,5 +1,5 @@
-Installation
-============
+<a id="Installation"></a>Installation
+=====================================
 
 These are the instructions for manual Director installations. You can
 learn more about how to automate this in the [automation](03-Automation.md) section
diff --git a/doc/03-Automation.md b/doc/03-Automation.md
index d212246..764cab9 100644
--- a/doc/03-Automation.md
+++ b/doc/03-Automation.md
@@ -1,5 +1,5 @@
 <a id="Automation"></a>Automation - Configuration management
-=====================================
+============================================================
 
 Director has been designed to work in distributed environments. In case
 you're using tools like Puppet, Ansible, Salt (R)?ex or similar, this
diff --git a/doc/04-Getting-started.md b/doc/04-Getting-started.md
index 9b58d93..b8bab30 100644
--- a/doc/04-Getting-started.md
+++ b/doc/04-Getting-started.md
@@ -1,5 +1,5 @@
-Getting started
-===============
+<a id="Getting-started"></a>Getting started
+===========================================
 
 When new to the Director please make your first steps with a naked Icinga
 environment. Director is not allowed to modify existing configuration in
diff --git a/doc/05-Upgrading.md b/doc/05-Upgrading.md
index b2a1ff5..f2f7d5a 100644
--- a/doc/05-Upgrading.md
+++ b/doc/05-Upgrading.md
@@ -1,19 +1,22 @@
-Upgrading
-=========
+<a id="Upgrading"></a>Upgrading
+===============================
 
-Icinga Director is very Upgrade-friendly. Drop the new version to your Icinga
+Icinga Director is very upgrade-friendly. Drop the new version to your Icinga
 Web 2 module folder and you're all done. Eventually refresh the page in your
 browser<sup>[[1]](#footnote1)</sup>, and you are ready to go. Should there any
 other actions be required, you will be told so in your frontend.
 
 Read more about:
 
-* [How to work with the latest GIT master](#...)
-* [Upgrading to 1.1.0](#...)
-* [Database schema upgrades](#...)
+* [How to work with the latest GIT master](#git-master)
+* [Upgrading to 1.1.0](#upgrade-to-1.1.0)
+* [Database schema upgrades](#schema-migrations)
 
-Work with the latest GIT master
--------------------------------
+And last but not least, having a look at our [Changelog](82-Changelog.md) is
+always a good idea before an upgrade.
+
+<a name="git-master"></a>Work with the latest GIT master
+--------------------------------------------------------
 
 Icinga Director is still a very young project. Lot's of changes are going on,
 a lot of improvements, bug fixes and new features are still being added every
@@ -37,16 +40,16 @@ policy says that the master should never break, this might of course happen.
 In that case, please [let us know](https://dev.icinga.org/projects/icingaweb2-module-director/issues)
 We'll try to fix your issue as soon as possible. 
 
-Upgrading to 1.1.0
-------------------
+<a name="upgrade-to-1.1.0"></a>Upgrading to 1.1.0
+-------------------------------------------------
 
 There is nothing special to take care of. In case you are running 1.0.0 or any
 GIT master since then, all you need is to replace the Director module folder with
 the new one. Or to run `git checkout v1.1.0` in case you installed Director from
 GIT.
 
-Database schema upgrade
------------------------
+<a name="schema-migrations"></a>Database schema migrations
+----------------------------------------------------------
 
 In case there are any DB schema upgrades (and that's still often the case) this
 is no problem at all. They will pop up on your Director Dashboard and can be
diff --git a/doc/10-How-it-works.md b/doc/10-How-it-works.md
index ccf25d9..7f20725 100644
--- a/doc/10-How-it-works.md
+++ b/doc/10-How-it-works.md
@@ -1,5 +1,5 @@
-How it works
-============
+<a id="How-it-works"></a>How it works
+=====================================
 
 This chapter wants to give you some basic understanding off how the
 Director works with your Icinga installation. At least once you start
diff --git a/doc/12-Handling-custom-variables.md b/doc/12-Handling-custom-variables.md
index 47540ce..3c9a9cf 100644
--- a/doc/12-Handling-custom-variables.md
+++ b/doc/12-Handling-custom-variables.md
@@ -1,5 +1,5 @@
-Working with custom variables
-=============================
+<a id="Handling-custom-variables"></a>Working with custom variables
+===================================================================
 
 Icinga Director allows you to work with custom variables in a very
 powerful way. It implements the concept of `Data fields`. If you want
diff --git a/doc/60-CLI.md b/doc/60-CLI.md
index e922de8..091a713 100644
--- a/doc/60-CLI.md
+++ b/doc/60-CLI.md
@@ -1,5 +1,5 @@
-Director CLI
-============
+<a id="CLI"></a>Director CLI
+============================
 
 Large parts of the Director's functionality are also available on your CLI.
 
diff --git a/doc/70-Import-and-Sync.md b/doc/70-Import-and-Sync.md
index 866a404..5b833f2 100644
--- a/doc/70-Import-and-Sync.md
+++ b/doc/70-Import-and-Sync.md
@@ -1,5 +1,5 @@
-Import and Synchronization
-==========================
+<a id="Import-and-Sync"></a>Import and Synchronization
+======================================================
 
 Icinga Director offers very powerful mechanisms when it comes to fetching data
 from external data sources.
diff --git a/doc/70-REST-API.md b/doc/70-REST-API.md
index 97b22ef..ee72a4b 100644
--- a/doc/70-REST-API.md
+++ b/doc/70-REST-API.md
@@ -1,5 +1,5 @@
-The Icinga Director REST API
-============================
+<a id="REST-API"></a>The Icinga Director REST API
+=================================================
 
 Introduction
 ------------
diff --git a/doc/79-Jobs.md b/doc/79-Jobs.md
index 4da7598..e9ee009 100644
--- a/doc/79-Jobs.md
+++ b/doc/79-Jobs.md
@@ -1,5 +1,5 @@
-Jobs
-====
+<a id="Jobs"></a>Jobs
+=====================
 
 Director allows you to schedule eventually long-running tasks so that they
 can run in the background. Currently this includes:
diff --git a/doc/80-FAQ.md b/doc/80-FAQ.md
index 4efac18..0721b58 100644
--- a/doc/80-FAQ.md
+++ b/doc/80-FAQ.md
@@ -1,5 +1,5 @@
-Frequently Asked Questions
-==========================
+<a id="FAQ"></a>Frequently Asked Questions
+==========================================
 
 I got an exception...
 ---------------------
diff --git a/doc/91-Want-more.md b/doc/91-Want-more.md
index 8a8f2fe..0d28729 100644
--- a/doc/91-Want-more.md
+++ b/doc/91-Want-more.md
@@ -1,5 +1,5 @@
-Want more?
-==========
+<a id="Want-more"></a>Want more?
+================================
 
 Icinga2 configuration is a full-blown DSL, not just a configuration
 format. It provides endless possibilities, the very same thing can



More information about the icinga-checkins mailing list