Skip to content

canonical/docs.ubuntu.com

Repository files navigation

Ubuntu documentation service

CircleCI build status Code coverage

A central platform for hosting Ubuntu's various documentation portals.

Local development

Dependencies

First install Docker. Linux users may need to add their user to the docker group.

Run the local development server

To run the site locally:

./run # Download containers, run the dev server and watch for sass changes

The first time this will take along time as it downloads and builds the documentation.

Now visit http://127.0.0.1:8007.

To see what other ./run commands are available, run ./run usage.

Deploy

You can find the deployment config in the deploy folder.

Licenses

The content of this project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying code used to format and display that content is licensed under the LGPLv3 by Canonical Ltd.


@nottrobin is the champion for this project.

With ♥ from Canonical.