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鈥檒l 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

Conversation

@bobheadxi
Copy link
Member

bobheadxi commented Feb 8, 2019

馃師 Ticket(s): Closes #479, closes #478, closes #477


馃懛 Changes

New slate-generated docs!

I'm hoping these docs will be a more user-friendly way of introducing someone to using Inertia.

Hoping to eventually deploy this to inertia.ubclaunchpad.com or something 馃榿

This thing is set up using my fork of Slate, which adds some configuration options that arent there in the parent repo

The colour scheme comes from @asitu 's Inertia Web designs here: https://app.zeplin.io/project/5b09a43c55faa0b37bb43879/screen/5b22f137c2f9e5b732b5ef86

Wrote a quick Medium post as well

馃敠 Testing Instructions

make docs
make run-docs

go to http://localhost:4567/#inertia

Todo

  • polish wording on current sections
  • finish as many TODOs as possible before I get sick of writing
  • add favicon
  • remove redundant sections from README
  • CNAME
@codecov

This comment has been minimized.

Copy link

codecov bot commented Feb 8, 2019

Codecov Report

Merging #536 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #536   +/-   ##
=======================================
  Coverage   56.21%   56.21%           
=======================================
  Files          60       60           
  Lines        2991     2991           
=======================================
  Hits         1681     1681           
  Misses       1102     1102           
  Partials      208      208

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update 680e21d...c6b6009. Read the comment docs.

docs_src/index.html.md Outdated Show resolved Hide resolved
docs_src/index.html.md Outdated Show resolved Hide resolved
docs_src/index.html.md Outdated Show resolved Hide resolved
docs_src/index.html.md Outdated Show resolved Hide resolved
docs_src/index.html.md Outdated Show resolved Hide resolved
Make sure you don't reveal your keys to anyone else, as a malicious user could
incure pretty significant charges at your expense. Also make sure you keep them
somewhere you won't lose the keys, especially the "secret access key", as you won't
be able to see them again later from the console (you'll have to create a new

This comment has been minimized.

Copy link
@rwblickhan

rwblickhan Feb 8, 2019

Contributor

You won't have to create a new user, you can invalidate and create new keys for the same user (and indeed key rotation on a regular basis is strongly encouraged by AWS anyway).

This comment has been minimized.

Copy link
@bobheadxi

bobheadxi Feb 8, 2019

Author Member

TIL ill fix this

This comment has been minimized.

Copy link
@bobheadxi

bobheadxi Feb 8, 2019

Author Member

I've added a new notice:


If you lose your keys, you can simply invalidate and create new keys for the same user (and indeed key rotation on a regular basis is strongly encouraged by AWS anyway).
docs_src/index.html.md Outdated Show resolved Hide resolved
docs_src/index.html.md Outdated Show resolved Hide resolved
docs_src/index.html.md Outdated Show resolved Hide resolved
@bobheadxi bobheadxi added pr: finalized and removed pr: wip labels Feb 9, 2019
bobheadxi added 4 commits Feb 9, 2019
@bobheadxi bobheadxi merged commit 40bfc25 into master Feb 9, 2019
5 checks passed
5 checks passed
codecov/project 56.21% remains the same compared to 680e21d
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@bobheadxi bobheadxi deleted the docs/slate branch Feb 9, 2019
bobheadxi added a commit that referenced this pull request Feb 9, 2019
* for gh-pages served from /docs, CNAME should be in /docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.