New Documentation Site for the Juju Ecosystem!

Hi everyone,

As some of you may have noticed, our documentation site looks different :wink:


We have officially deployed the next generation of the Juju ecosystem documentation!

Design :paintbrush:

A huge kudos to @tmihoc , @serelislukas , @mdivo and @abbiesims !

They invested time in surveying, getting feedback, demonstrating prototypes and mockups.

Their mission: to design a site that is fit for users of different levels of Juju experience (e.g. newcomers, existing users…) and different personas (e.g. sysadmins, developers …)

Federation of the Juju Ecosystem :handshake:

juju.is/docs is expanding to Juju, Terraform Provider, Python Libjuju, JAAS, Charmcraft and Ops.

The documentation structure conveys the spirit of interoperability between the different parts of the ecosystem as well as their independent ability to work well on their own.

Versioning :page_facing_up:

An important request we hear often is the explicit versioning of Juju and other parts of the ecosystem; what exactly is supported in each version.


Call to Action!

We need your feedback on the new ever-evolving structure of the site.

In addition to being able to open a bug on GitHub for any documentation issue, you can also actively contribute to the documentation by suggesting edits

How

As the new documentation will be based on RTD (ReadTheDocs), documentation is treated as part of the codebase and is hosted on GitHub.

In high-level, same process as contributing to the codebase of an open source project applies:

  • Use your favorite editor to make the changes for the docs (under juju/docs)
  • (Optional) you can run make clean make run under juju/docs to host a local version of your changes with sphinx
  • Your changes need to be a pull request, we will review and merge

Prerequisites

  • A GitHub account and access, working git
  • Fork and locally pull your juju repo
  • Install juju

For further information on how contribute make sure you visit our repo

Thank you! Let us know what you think in the comments below.

6 Likes