diff --git a/conf.py b/conf.py index 4731e4a66..e20927977 100644 --- a/conf.py +++ b/conf.py @@ -23,7 +23,7 @@ # The title you want to display for the documentation in the sidebar. # You might want to include a version number here. # To not display any title, set this option to an empty string. -html_title = project + '3.5 documentation' +html_title = project + ' documentation' # The default value uses CC-BY-SA as the license and the current year # as the copyright year. diff --git a/index.md b/index.md new file mode 100644 index 000000000..53399b112 --- /dev/null +++ b/index.md @@ -0,0 +1,76 @@ +(home)= +# Juju documentation + +Juju is an open-source ecosystem of tools designed to revolutionise the speed and quality of software operations on any cloud. + +The Juju ecosystem comprises a charm hub, a charm SDK, and Juju. + +- A charm is a software operator that packages an application with operations code in a way understandable to Juju. +- Juju is an orchestration engine that uses charms and the applications deployed from them to make operations as simple as `juju deploy foo`, `juju configure foo`, `juju integrate foo bar`, `juju scale foo`, `juju upgrade foo`, etc. – for any application on any type of cloud. + +> [Browse existing charms on Charmhub](https://charmhub.io/)

[Browse supported clouds](https://juju.is/docs/juju/juju-supported-clouds) + +At a time when operations code is still largely stuck with handcrafted code, YAML, or Kubernetes-only operators, the Juju paradigm offers reusable code, testable operations, and multicloud, so you can achieve a lot more, a lot better, and a lot faster. + +> [Did you know? Juju also has an integration with Terraform!](https://juju.is/docs/juju/terraform-juju-client) + +Whether you are a developer wondering how to make your application ready for the cloud, a cloud system administrator or an SRE tired of YAML, or a business owner, Juju can help. + + +--- + +## In this documentation + +````{grid} 1 1 2 2 + +```{grid-item} [Tutorial](/tutorial/get_started) + +**Start here**: a hands-on introduction to Juju for new users +``` + +```{grid-item} [How-to guides](/how-to/index) + +**Step-by-step guides** covering key operations and common tasks +``` + +```` + +````{grid} 1 1 2 2 +:reverse: + +```{grid-item} [Reference](/reference/index) + +**Technical information** - specifications, APIs, architecture +``` + +```{grid-item} [Explanation](/explanation/index) + +**Discussion and clarification** of key topics +``` + +```` + +--- + +## Project and community + +Juju is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback. + +* [Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct) +* [Join our online forum](https://discourse.charmhub.io/) +* [Join our online chat](https://matrix.to/#/#charmhub-juju:ubuntu.com) +* Contribute +* Roadmap +* Thinking about using Juju for your next project? Get in touch! + + + +```{toctree} +:hidden: +:maxdepth: 2 + +self +Tutorial +/how-to/index +/reference/index +/explanation/index diff --git a/index.rst b/index.rst deleted file mode 100644 index 6563baf2e..000000000 --- a/index.rst +++ /dev/null @@ -1,68 +0,0 @@ -Starter pack -============ - -**A single sentence that says what the product is, succinctly and memorably.** -Consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et -dolore magna aliqua. - -**A paragraph of one to three short sentences, that describe what the product -does.** Urna cursus eget nunc scelerisque viverra mauris in. Nibh mauris -cursus mattis molestie a iaculis at vestibulum rhoncus est pellentesque -elit. Diam phasellus vestibulum lorem sed. - -**A third paragraph of similar length, this time explaining what need the -product meets.** Dui ut ornare lectus sit amet est. Nunc sed augue lacus -viverra vitae congue eu consequat ac libero id faucibus nisl tincidunt eget -nullam. - -**Finally, a paragraph that describes whom the product is useful for.** Nunc -non blandit massa enim nec dui nunc mattis enim. Ornare arcu odio ut sem -nulla pharetra diam porttitor leo a diam sollicitudin tempor id eu. Ipsum -dolor sit amet consectetur adipiscing elit pellentesque habitant. - ---------- - -In this documentation ---------------------- - -.. grid:: 1 1 2 2 - - .. grid-item:: :doc:`Tutorial ` - - **Start here**: a hands-on introduction to Example Product for new users - - .. grid-item:: :doc:`How-to guides ` - - **Step-by-step guides** covering key operations and common tasks - -.. grid:: 1 1 2 2 - :reverse: - - .. grid-item:: :doc:`Reference ` - - **Technical information** - specifications, APIs, architecture - - .. grid-item:: :doc:`Explanation ` - - **Discussion and clarification** of key topics - ---------- - -Project and community ---------------------- - -Example Project is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback. - -* Code of conduct -* Get support -* Join our online chat -* Contribute -* Roadmap -* Thinking about using Example Product for your next project? Get in touch! - - -.. toctree:: - :hidden: - :maxdepth: 2 - - self