Skip to content

docs: usage guide via slate#536

Merged
bobheadxi merged 43 commits into
masterfrom
docs/slate
Feb 9, 2019
Merged

docs: usage guide via slate#536
bobheadxi merged 43 commits into
masterfrom
docs/slate

Conversation

@bobheadxi

@bobheadxi bobheadxi commented Feb 8, 2019

Copy link
Copy Markdown
Member

🎟️ 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

codecov Bot commented Feb 8, 2019

Copy link
Copy Markdown

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.

Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md
Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md Outdated
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL ill fix this

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md
Comment thread docs_src/index.html.md Outdated
Comment thread docs_src/index.html.md
Comment thread docs_src/index.html.md
@bobheadxi bobheadxi added pr: finalized needs review and final approval and removed pr: wip in progress but seeking feedback labels Feb 9, 2019
@bobheadxi bobheadxi merged commit 40bfc25 into master Feb 9, 2019
@bobheadxi bobheadxi deleted the docs/slate branch February 9, 2019 02:53
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

Labels

pr: finalized needs review and final approval

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Project configuration docs Instance provisioning docs 2FA documentation

3 participants