Guides and principles from the web team at Canonical and Ubuntu
Branch: master
Clone or download
barrymcgee Merge pull request #172 from barrymcgee/fix-markdown-lists
Fix markdown list in copy-review.md
Latest commit 0386b30 Feb 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_layouts
coding Merge branch 'master' into prettier Feb 7, 2019
content Use spaces for nested lists Feb 7, 2019
css Run Prettier over all files Feb 4, 2019
design Run Prettier over all files Feb 4, 2019
miscellaneous Run Prettier over all files Feb 4, 2019
project-management Prettier cleanup Feb 7, 2019
project-structure Merge branch 'master' into prettier Feb 7, 2019
workflow Run Prettier over all files Feb 4, 2019
.editorconfig Add .editorconfig to enforce 2 space indent in Markdown files Feb 7, 2019
.gitignore Add Gemfile and local dev instructions to README Feb 1, 2019
.prettierignore Run Prettier over all files Feb 4, 2019
CONTRIBUTING.md Run Prettier over all files Feb 4, 2019
Gemfile Add Gemfile and local dev instructions to README Feb 1, 2019
Gemfile.lock Add Gemfile and local dev instructions to README Feb 1, 2019
LICENSE.md Add LGPLv3 license Feb 1, 2019
README.md Prettier cleanup Feb 7, 2019
_config.yml
index.html Improve website Nov 27, 2018
yarn.lock Add Prettier Feb 4, 2019

README.md

Web and design team practices

A collection of documents that describe best practices for Canonical web team.

These can be also be viewed at https://canonical-webteam.github.io/practices/.

Run site locally

This site is built using Jekyll.

To run this site locally, you'll need to first install Ruby on your local machine.

Once you have installed Ruby, you can then install Bundler by running;

gem install bundler -v 1.17.3

The next step is to install the Ruby gems required to run the site with Bundler;

bundle install

You can then serve the site using Jekyll;

jekyll serve

...which should open the site locally in your browser at http://127.0.0.1:4000/practices/

Contributing

For guidelines on contributing to these documents, see CONTRIBUTING.md.

Code formatting

This code base uses Prettier to ensure consistent formatting.

To run Prettier over the code base (assuming you have npm installed), run:

npx prettier --write **/*

Troubleshooting

Jekyll not found

If you encounter a problem when trying to run an installed gem, that states that it can not be found, make sure that the directory in which gems are installed is included in your PATH. You can verify this by typing echo $PATH in a terminal and checking for the folder in the output. If you are not sure what folder your gems are installed into, run gem env | grep EXECUTABLE\ DIRECTORY and add the path that is printed into your PATH environment variable.

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.