Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 2.85 KB

README.md

File metadata and controls

46 lines (26 loc) · 2.85 KB

ubuntu.com codebase

Code coverage Cypress checks

Ubuntu is an open source software operating system that runs from the desktop, to the cloud, to all your internet connected things. Ubuntu.com is the website that helps people learn about, download and get started with Ubuntu. This repo is the codebase and content for the ubuntu.com website.

The site is largely maintained by the Web and Design team at Canonical. It is a simple, database-less, informational website project based on Flask and hosted on a Charmed Kubernetes cluster.

You can read more about the application's architecture in ARCHITECTURE.md.

Bugs and issues

If you have found a bug on the site or have an idea for a new feature, feel free to create a new issue, or suggest a fix by creating a pull request. You can also find a link to create issues in the footer of every page of the site itself.

If you have found a bug in the Ubuntu OS itself, please file it here.

Local development

The simplest way to run the site locally is using the dotrun snap. Please use the installation scripts mentioned in the README to install dotrun.

Once it's installed, run the project with:

dotrun

For Mac users, in case running dotrun returns an error related to Chromium, add the following line to your local .env.local file (create one if you don't have it):

PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true

Once the server has started, you can visit http://127.0.0.1:8001 in your browser.

For more information on how to work with ubuntu.com project please refer to HACKING.md.

Deploy

You can find the deployment config in the deploy folder.

License

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.

With ♥ from Canonical