refactor the charm writing pages menu

Peter Matulis · Peter Matulis · commit 7242fa699ef2 · 2019-02-27T05:33:45.000-05:00
diff --git a/src/en/authors-charm-store.md b/src/en/authors-charm-store.md
@@ -1,6 +1,6 @@
-Title: The Juju charm store
+Title: Working with the Charm Store
 
-# The Juju Charm Store
+# Working with the Charm Store
 
 Juju includes a charm store where charms and bundles can be uploaded,
 released (published), and optionally shared with other users.
diff --git a/src/en/authors-intro.md b/src/en/authors-intro.md
@@ -1,4 +1,4 @@
-Title: How to become a Juju charm author
+Title: Becoming a charm author
 
 # Becoming a charm author
 
diff --git a/src/en/charm-writing.md b/src/en/charm-writing.md
@@ -0,0 +1,56 @@
+Title: Charm writing
+
+# Charm writing
+
+[Getting started](developer-getting-started.md)
+
+[Event cycle and reactive states](developer-event-cycle.md)
+
+[Charm layers and states](developer-layers.md)
+
+[Writing a charm layer](developer-layer-example.md)
+
+[Interface layers](developer-layers-interfaces.md)
+
+[Upgrading a charm](developer-upgrade-charm.md)
+
+[Juju terms](developer-terms.md)
+
+[Juju metrics](location: developer-metrics.md)
+
+[Charm resources](developer-resources.md)
+
+[Network primitives](developer-network-primitives.md)
+
+[Implementing leadership](developer-leadership.md)
+
+[Implementing actions](developer-actions.md)
+
+[Implementing storage](developer-storage.md)
+
+[Writing charm tests](developer-testing.md)
+
+[Using Docker](howto-charm-with-docker.md)
+
+## Debugging
+
+ - [Debugging charm hooks](developer-debugging.md)
+ - [Debugging layers](developer-debug-layers.md)
+ - [DHX debugging plugin](developer-debug-dhx.md)
+
+## Charm authors
+
+ - [Becoming a charm author](authors-intro.md)
+ - [How hooks are run (Hook API)](location: authors-hook-environment.md)
+ - [Relations lifecycle](authors-relations-in-depth.md)
+ - [Implementing relations](authors-relations.md)
+ - [Charm leadership](authors-charm-leadership.md)
+ - [Hook errors](authors-hook-errors.md)
+ - [Subordinate applications](authors-subordinate-applications.md)
+
+## Charm Store
+
+ - [Working with the Charm Store](authors-charm-store.md)
+ - [Charm store policy](authors-charm-policy.md)
+ - [Best practices](authors-charm-best-practice.md)
+ - [Charm icons](authors-charm-icon.md)
diff --git a/src/en/charm-wrting.md b/src/en/charm-wrting.md
diff --git a/src/en/developer-debug-dhx.md b/src/en/developer-debug-dhx.md
@@ -1,6 +1,6 @@
-Title: DHX debug plugin  
+Title: DHX debugging plugin  
 
-# DHX: A Customized Hook Debugging Environment Plugin
+# DHX debugging plugin
 
 [DHX](https://github.com/juju/plugins/blob/master/juju-dhx) is a plugin --
 scripts that extend the functionality of Juju -- which allows you to fully and
diff --git a/src/en/developer-event-cycle.md b/src/en/developer-event-cycle.md
@@ -1,6 +1,6 @@
-Title: Event Cycle
+Title: Event cycle and reactive states
 
-# Event Cycle
+# Event cycle and reactive states
 
 When charming with the reactive framework, it’s possible to use
 developer-created states and boolean logic to run code when the states represent
@@ -9,8 +9,6 @@ and when it is available, or when the primary workload becomes available for
 use. These are additional “events” that are abstracted from the hook event cycle
 outlined later in this page.
 
-## Handling reactive states
-
 Many states can be performed during a single hook execution, as these abstracted
 states are run through a dispatcher, and ordering is not guaranteed. All state
 based events, like hook events, are required to be
diff --git a/src/en/developer-howto.md b/src/en/developer-howto.md
diff --git a/src/en/developer-layer-example.md b/src/en/developer-layer-example.md
@@ -1,6 +1,6 @@
-Title: Writing layer example
+Title: Writing a layer
 
-# Writing a layer by example
+# Writing a layer
 
 In this document, we will be writing a charm layer that installs and
 configures the [Vanilla forum software][].
diff --git a/src/en/developer-layers.md b/src/en/developer-layers.md
@@ -1,6 +1,6 @@
-Title: Layers for charm authoring  
+Title: Charm layers
 
-# Why build from layers
+# Charm layers
 
 When creating a charm, you always have the option of doing it the traditional
 way by creating each hook, implementing each side of the interface you need for
diff --git a/src/en/developer-leadership.md b/src/en/developer-leadership.md
@@ -1,4 +1,4 @@
-Title: Implementing Leadership
+Title: Implementing leadership
 
 # Implementing leadership
 
diff --git a/src/en/developer-network-primitives.md b/src/en/developer-network-primitives.md
@@ -1,6 +1,6 @@
-Title: Charm Network Primitives
+Title: Network primitives
 
-# Network Primitives
+# Network primitives
 
 The `network-get` hook tool allows charms to discover important network related
 information. There are 2 key things a charm needs to know about its local
diff --git a/src/en/developer-resources.md b/src/en/developer-resources.md
@@ -1,6 +1,6 @@
-Title: Using resources | Developer guide
+Title: Charm resources
 
-# Using resources
+# Charm resources
 
 Many applications require binary resources to complete the install process.
 While it is possible for a charm to download this software from package
diff --git a/src/en/developer-storage.md b/src/en/developer-storage.md
@@ -1,6 +1,6 @@
-Title: Writing charms using storage  
+Title: Implementing storage
 
-# Writing charms that use storage
+# Implementing storage
 
 The storage feature can be implemented in any charm running on Juju version
 1.25 or later. For applications that can take advantage of block storage or
diff --git a/src/en/developer-testing.md b/src/en/developer-testing.md
@@ -1,6 +1,6 @@
 Title: Writing charm tests
 
-# Writing Charm Tests
+# Writing charm tests
 
 Charm authors will have the best insight into whether or not a charm is working
 properly. It is up to the author to create tests that ensure quality and
diff --git a/src/en/howto-charm-with-docker.md b/src/en/howto-charm-with-docker.md
@@ -1,12 +1,12 @@
-Title: Using Docker in charms
+Title: Using Docker
 
-# Charming with Docker
+# Using Docker
 
 You have a Docker container and you heard about Juju. Juju can deploy your
 Docker container to any cloud. This document will outline the best practices
 for using Juju to deploy Docker images.
 
-### First things first
+## First things first
 
 This document assumes you already know about [Docker](http://docker.com) and
 how to create, pull and use application containers.
@@ -17,9 +17,9 @@ with the technology, there is more information on
 of Juju software on <https://jujucharms.com>. This document will detail some of
 the higher level [concepts of Juju][concepts].
 
-### Reactive and layered charms
+## Reactive and layered charms
 
-#### Reactive
+### Reactive
 
 Another software paradigm is
 [reactive programming](https://en.wikipedia.org/wiki/Reactive_programming). Do
@@ -30,30 +30,30 @@ execution is controlled by boolean logic. You can define when the conditions
 are right, run this code, or when something is not set, run different code or
 do nothing at all.
 
-#### Layers
+### Layers
 
 The idea of charm layers is to combine objects or data into more complex objects
 or data. When applied to Charms, layers allow you to extend or build off
 other charms to make more complex or useful charms. The `layer.yaml` file in
 the root directory of the charm controls what layer(s) will be imported.
 
-#### Reactive Charms
+### Reactive charms
 
 The docker charm makes use of the
 [charms.reactive](https://charmsreactive.readthedocs.io/) python framework.
 The code for the docker layer can be found in the `reactive/` folder in the
 root charm directory.
 
-#### Building Charms
+### Building charms
 
 The docker layer makes use of the
 [Charm Layers](developer-layers.html)
 concept building off the base charm and creating its own layer of added
 functionality.
 
-### Start with Docker, and build your own
+## Start with Docker, and build your own
 
-#### layer-docker charm
+### layer-docker charm
 
 The layer-docker charm can be found on github.com at:
 <https://github.com/juju-solutions/layer-docker>. This charm encapsulates
@@ -73,11 +73,11 @@ to install and upgrade docker. Freeing you to focus on delivering your applicati
 layer and focus on how to do that.
 
 ## A guided example
+
 In the first section we illustrated the workflow. The resulting charm will
 be a simple method to serve static content with NGinx, including a relation to
 a load balancer charm.
 
-
 # Charm authoring using reactive paradigm
 
 The [charms.reactive](https://charmsreactive.readthedocs.io/) is a python

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Title: How to become a Juju charm author`
	`1`	`+Title: Becoming a charm author`
`2`	`2`
`3`	`3`	`# Becoming a charm author`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Title: Implementing Leadership`
	`1`	`+Title: Implementing leadership`
`2`	`2`
`3`	`3`	`# Implementing leadership`
`4`	`4`