Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: usage guide via slate #536

Merged
merged 43 commits into from Feb 9, 2019
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
365431e
docs: prototype Slate documentation and build scripts
bobheadxi Feb 7, 2019
07f6286
chore: add output to build_docs.sh
bobheadxi Feb 7, 2019
c04e52c
chore: remove docs_build in clean
bobheadxi Feb 7, 2019
e5ff432
wip docs
bobheadxi Feb 7, 2019
4a8e42f
chore: set -e on doc build, check for slate
bobheadxi Feb 7, 2019
bda572e
chore: fix symlinking
bobheadxi Feb 8, 2019
8b7b76f
chore: working symlink live-reload
bobheadxi Feb 8, 2019
ae8e8e7
docs: sync colour scheme with web app design
bobheadxi Feb 8, 2019
3401ec7
More WIP docs
bobheadxi Feb 8, 2019
0a13a48
rebuild docs
bobheadxi Feb 8, 2019
ab67d83
fix makeup
bobheadxi Feb 8, 2019
0bf5b01
note that daemon init is not needed with provision, minor fixes
bobheadxi Feb 8, 2019
cab7bae
grammar
bobheadxi Feb 8, 2019
71c7e1f
rebuild docs
bobheadxi Feb 8, 2019
58a026d
tweaks
bobheadxi Feb 8, 2019
92cd483
rebuild
bobheadxi Feb 8, 2019
99d8546
fuck
bobheadxi Feb 8, 2019
0d3cfbe
adjust breakpoints
bobheadxi Feb 8, 2019
0dc25d8
update 2fa section
bobheadxi Feb 8, 2019
876eba0
update api key section
bobheadxi Feb 8, 2019
892d1cc
update resource management section
bobheadxi Feb 8, 2019
688985c
flesh out misc sections
bobheadxi Feb 8, 2019
7bd5097
more misc stuff
bobheadxi Feb 8, 2019
65dfd49
minor tweaks
bobheadxi Feb 8, 2019
a17554c
tweaks to notices
bobheadxi Feb 8, 2019
c4622bc
flesh out advanced section
bobheadxi Feb 8, 2019
686a384
clean up
bobheadxi Feb 8, 2019
870c960
build
bobheadxi Feb 8, 2019
4442fbb
add ec2 provisioning walkthrough
bobheadxi Feb 8, 2019
513f837
make key notice a warning
bobheadxi Feb 8, 2019
6cdac38
add note about generating access keys
bobheadxi Feb 8, 2019
dfb741b
note that inertia will prompt for keys
bobheadxi Feb 8, 2019
530079d
word
bobheadxi Feb 8, 2019
5edac97
more fixes
bobheadxi Feb 8, 2019
ed53f3c
remove redundant parts from README
bobheadxi Feb 8, 2019
d725515
add 'why use inertia'
bobheadxi Feb 8, 2019
a60b77e
add cname
bobheadxi Feb 8, 2019
1731222
Merge branch 'master' of github.com:ubclaunchpad/inertia into docs/slate
bobheadxi Feb 9, 2019
4611a43
add favicon, improve hacks
bobheadxi Feb 9, 2019
336f93d
adjust README
bobheadxi Feb 9, 2019
100891a
adjust SSL cert information
bobheadxi Feb 9, 2019
008acdd
add documentation issue template
bobheadxi Feb 9, 2019
c6b6009
add section on building documentation in CONTRIBUTING
bobheadxi Feb 9, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Expand Up @@ -6,3 +6,6 @@
*.png binary
*.jpg binary
*.pdf binary

# Mark docs as generated
docs/* linguist-generated
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -40,3 +40,6 @@ public/

# JetBrains
.idea

# Doc build
docs_build
36 changes: 36 additions & 0 deletions .scripts/build_docs.sh
@@ -0,0 +1,36 @@
#! /bin/bash

set -e

# Get Slate
echo "[INFO] Getting Slate"
mkdir -p docs_build
cd docs_build
if [ ! -d slate ]; then
# Using Robert's fork for now, for extra swag
git clone https://github.com/bobheadxi/slate.git
else
echo "[INFO] Slate already present in docs_build/slate"
fi

# Add custom config to Slate
echo "[INFO] Hacking Slate configuration"
echo "files.watch :source, path: File.join(root, '../../docs_src')" \
>> slate/config.rb

# Set up Slate for build
echo "[INFO] Linking assets"
ln -fs "$(dirname "$(pwd)")"/docs_src/index.html.md \
slate/source/index.html.md
ln -fs "$(dirname "$(pwd)")"/docs_src/stylesheets/_variables.scss \
slate/source/stylesheets/_variables.scss
ln -fs "$(dirname "$(pwd)")"/.static/inertia.png \
slate/source/images/logo.png
echo "[INFO] Installing Slate dependencies"
cd slate
bundle install

# Execute build
echo "[INFO] Building documentation"
rm -rf docs
bundle exec middleman build --clean --build-dir=../../docs
Binary file added .static/inertia.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions Makefile
Expand Up @@ -16,6 +16,7 @@ ls:
clean: testenv-clean
go clean -testcache
rm -f ./inertia
rm -rf ./docs_build
find . -type f -name inertia.\* -exec rm {} \;

# Install all dependencies
Expand Down Expand Up @@ -182,3 +183,11 @@ web-run-sandbox:
.PHONY: web-build
web-build:
(cd ./daemon/web; npm install --production; npm run build)

.PHONY: docs
docs:
sh .scripts/build_docs.sh

.PHONY: run-docs
run-docs:
( cd docs_build/slate ; bundle exec middleman server --verbose )
Binary file added docs/fonts/slate.eot
Binary file not shown.
14 changes: 14 additions & 0 deletions docs/fonts/slate.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fonts/slate.ttf
Binary file not shown.
Binary file added docs/fonts/slate.woff
Binary file not shown.
Binary file added docs/fonts/slate.woff2
Binary file not shown.
Binary file added docs/images/aws-ec2-add-user.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/aws-ec2-iam-add.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/aws-ec2-iam-perm.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/navbar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.