Find file History
Latest commit ef99c9c Feb 8, 2017 @ocdtrekkie ocdtrekkie committed on GitHub Docs typo
Permalink
..
Failed to load latest commit information.
administering Documentation typo Feb 7, 2017
developing Docs typo Feb 9, 2017
sandstorm_readthedocs_modified_theme
using Merge pull request #2694 from sandstorm-io/docs-userns-optional Oct 27, 2016
vagrant-spk Docs: improve sentence wording Feb 1, 2017
README.md Add documentation explaining how to get a shell within a grain May 13, 2016
administering.md Scrub Sandstorm for Work from docs. Feb 5, 2017
analytics.js docs: Add Azure Active Directory docs Oct 18, 2016
developing.md add missing link Aug 17, 2016
extra.css Change mobile nav colour to purple Feb 7, 2017
generate.sh Support using virtualenv for docs build Jan 24, 2016
guided-tour.md Text tweaks & update guided tour instructions Apr 24, 2016
index.md
install.md Update Docs to specify new minimum kernel version Dec 14, 2016
using.md Text tweaks & update guided tour instructions Apr 24, 2016

README.md

How to view these docs

https://docs.sandstorm.io/

How to edit these docs

Run the following.

cd ~/projects/sandstorm
virtualenv tmp/docs-virtualenv
tmp/docs-virtualenv/bin/pip install mkdocs
tmp/docs-virtualenv/bin/pip install markdown-inline-graphviz
# Get an unreleased version of mkdocs because we need the readthedocs theme 'Searching...' fix
tmp/docs-virtualenv/bin/pip install --upgrade git+https://github.com/mkdocs/mkdocs.git#egg=mkdocs
# Get "dot" so we can render inline dot/graphviz
sudo apt-get install -y graphviz
tmp/docs-virtualenv/bin/mkdocs serve

Then visit http://localhost:8000/

How to add images to the docs

In quick bullet points:

  • You can add images to the docs.

  • Look for examples of Markdown image syntax. For example, docs/administering/faq.md

  • Set the IMG SRC to point at whatever URL you like, preferably a Sandstorm static publishing URL that you own.

  • When your pull request gets merged, @paulproteus will copy them to a Davros grain he controls on oasis.sandstorm.io.

The reason for all this is that images can bloat a git repository a lot, so for now, we don't store the images the main Sandstorm git repo.

How to deploy to docs.sandstorm.io

  • Ask Asheesh to share a particular GitWeb Pages grain with you. It's located on https://alpha.sandstorm.io/.

  • Do a git clone of that repository into a directory, like:

git clone https://my_repo@alpha-api.sandstorm.io/ tmp/sandstorm-docs
  • Run generate.sh to re-generate the docs, then commit them to this git repo.
PATH=$PATH:$PWD/tmp/docs-virtualenv/bin bash docs/generate.sh -d tmp/sandstorm-docs
  • Run generate.sh with the -p flag to actually push them to the live site.
PATH=$PATH:$PWD/tmp/docs-virtualenv/bin bash docs/generate.sh -d tmp/sandstorm-docs -p