The home of docs about snaps and snapcraft
degville Merge pull request #448 from canonical-docs/degville-patch-1
Update README.md to inform visitors these docs are deprecated
Latest commit 1798b95 Oct 17, 2018

README.md

Snapcraft Documentation Website (deprecated)

The is the source code for the old Snapcraft Documentation Website, formally hosted at https://docs.snapcraft.io, and built with Jekyll.

Snapcraft documentation is now automatically generated from the posts and pages hosted on the Snapcraft forum. See our Documentation guidelines if you'd like to contribute.

Building these docs

Requirements:

  • Docker should be installed
  • (Linux only) user should be part of the docker group
    • sudo adduser <user> docker

The docs website can be built locally by using the ./run script available within this repository:

./run serve

Once the environment is created, you can view it at http://localhost:8202/ in your browser.