Documentation outline


#1

This is a work in progress of the new outline for documentation. All of these pages already exist online (hyperlinks to be filled in soon) and some of the existing minor pages have been omitted for now (consider them under Miscellaneous). The charm-writing pages have also been excluded as they require a rewrite.

If you would like to see something covered that does not appear below add it to the menu and put it in parentheses.

At the end is a compact (tablerised) version of the User guide. The underlying markdown is unsightly but a TOC is usually quite static. Edit: I’m told that the web team process being worked on (to get this information published on the web site) probably won’t be able to handle the underlying markdown.

User guide

Introduction

Clouds

Using Juju

Administering Juju

  • Juju users
  • Scaling up and down
  • Upgrading applications
  • Updating a machine series
  • Controller backups
  • Controller high availability
  • Application high availability

Advanced topics

  • Charm bundles
  • Using storage
  • Working with actions
  • Working with resources
  • Tools

Networking

Troubleshooting

Miscellaneous

Charm writer’s manual

Reference

  • Release notes
  • Juju commands
  • Juju constraints
  • Juju charm hooks
  • Juju environment variables
  • Juju hook tools
  • metadata.yaml
  • API docs
  • Status values
  • Machine/unit numbering

COMPACT VERSION

User guide

Introduction
* About Juju
* Try it out
* Install Juju
* Concepts
* Introductory tutorials

Clouds Using Juju Administering Juju
* Overview of clouds
* Cloud credentials
* (List of supported clouds)




* Creating a controller
* Working with models
* Deploying applications
* Using constraints
* Configuring applications
* Managing relations
* Removing things
* Juju users
* Scaling up and down
* Upgrading applications
* Updating a machine series
* Controller backups
* Controller high availability
* Application high availability

Advanced topics Networking Troubleshooting
* Charm bundles
* Using storage
* Working with actions
* Working with resources
* Tools
* Working offline
* Fan container networking
* Network spaces


* Overview
* Juju logs