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
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes Add Raspbian and elementary OS to the snap install navigation links. May 11, 2018
_layouts
_sass Fix max-width to 1038px as the rest of the site Aug 29, 2018
build-snaps Merge branch 'fixed-width-for-docs' of github.com:therealjuan/snappy-… Aug 20, 2018
core Add Pop doc May 24, 2018
deprecation-notices Fix title in dn9 deprecation notice May 3, 2018
media Review changes Feb 20, 2017
reference
snaps Fixed a typo in snaps/philosophy Aug 28, 2018
.dockerignore Docker config for snappy docs Sep 25, 2017
.env Update port to 8202 Nov 7, 2017
.gitignore
.sass-lint.yml
Dockerfile
Gemfile Setup ./run infrastructure Sep 25, 2017
Gemfile.lock
README.md Update README.md to inform visitors these docs are deprecated Oct 17, 2018
_config.yml Docker config for snappy docs Sep 25, 2017
index.md Update index.md Mar 23, 2018
nginx.conf Redirect python -> build-snaps/python Jul 26, 2018
package.json Update to generator@v1.1.0 Sep 29, 2017
placeholder.md Update all markdown files to use the documentation layout Sep 25, 2017
run Update ./run to v2.5.0 Jan 15, 2018
yarn.lock Update lockfiles Sep 29, 2017

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.