Rails documentation in sphinx #57

cilim · 2016-09-23T09:52:40Z

PR for #48

…ubmodule

coveralls · 2016-09-23T09:58:08Z

Coverage remained the same at 97.25% when pulling 28a6983 on mc-sphinx-documentation into 145a2da on master.

coveralls · 2016-09-26T11:32:56Z

Coverage remained the same at 97.25% when pulling 2f8a298 on mc-sphinx-documentation into 145a2da on master.

…thentication specs

coveralls · 2016-09-28T09:01:48Z

Coverage remained the same at 97.25% when pulling 07b9425 on mc-sphinx-documentation into 145a2da on master.

coveralls · 2016-09-28T09:13:14Z

Coverage remained the same at 97.25% when pulling 68fc7a5 on mc-sphinx-documentation into 145a2da on master.

coveralls · 2016-10-25T11:51:26Z

Coverage remained the same at 97.25% when pulling aff5864 on mc-sphinx-documentation into 145a2da on master.

… SDK documentation links

coveralls · 2016-11-02T14:54:05Z

Coverage remained the same at 97.509% when pulling e195a79 on mc-sphinx-documentation into e074f01 on master.

DamirSvrtan · 2016-11-08T09:13:29Z

docs/authentication.rst

+
+If you are building a web application that serves traditional HTML pages, or a
+Single Page Application (Angular/React), this library will handle the cookie
+sessions for you.  No special configuration is necessary.


cookies for you*

DamirSvrtan · 2016-11-08T09:13:39Z

docs/authentication.rst

+sessions for you.  No special configuration is necessary.
+
+To use cookie authentication, simply use the ``require_authentication!`` before callback:
+


before action*

DamirSvrtan · 2016-11-08T09:14:37Z

docs/authentication.rst

+
+Here is an example configuration block, with the default settings:
+
+.. code-block:: ruby


code-block should be yaml, not ruby.

DamirSvrtan · 2016-11-08T09:15:06Z

docs/authentication.rst

+Token Validation Strategy
+.........................
+
+When a request comes into your server, this gem will use the Access Token


to your server*

DamirSvrtan · 2016-11-08T09:16:00Z

docs/authentication.rst

+
+Opt-in to ``stormpath`` validation with this configuration:
+
+.. code-block:: ruby


same thing with code-block. Please change it in all places needed.

DamirSvrtan · 2016-11-08T09:20:59Z

docs/authentication.rst

+authorization and security, this strategy should be used.  In this situation
+the developer does a one-time exchange of their API Keys for an Access Token.
+This Access Token is time limited and must be periodically refreshed.  This adds a
+layer of security, at the cost of being less simple than HTTP Basic


I would use more complex instead of less simple :)

DamirSvrtan · 2016-11-08T09:22:51Z

docs/changelog.rst

+- Use Faker to generate random test data
+- Rename all user instances to account
+
+Released on Aug 22, 2016


Shouldn't a Version 2.0.1 be placed on top of this?

coveralls · 2016-11-08T10:31:37Z

Coverage decreased (-31.4%) to 66.102% when pulling 3cb9452 on mc-sphinx-documentation into e074f01 on master.

coveralls · 2016-11-08T10:48:30Z

Coverage remained the same at 97.609% when pulling d033464 on mc-sphinx-documentation into d1c9a69 on master.

cilim · 2016-11-08T11:46:26Z

Comments fixed @DamirSvrtan

cilim added 16 commits September 20, 2016 13:35

Initialize sphinx docs folder structure, initialize stormpath theme s…

83cf603

…ubmodule

Adjust index page and create the about page

bd10b81

Create quickstart page

aaf2a5c

Create configuration page

0444cdd

Create user_data page

57db9bd

Add help page

ca61177

Add contributors page

386e703

Add changelog page

f5a2120

Add authentication page

0df101f

Add registration page

1be9534

Add login page

7ff6b97

Add logout page

708b620

Add password reset page

38a626a

Add templates page

3c4e6ac

Add social login page

88b5d68

Remove todos, fix sphinx warning and errors

28a6983

cilim assigned DamirSvrtan Sep 23, 2016

Finish documenting ID Site instructions

2f8a298

Use random unencoded string as api key id and secret for the basic au…

07b9425

…thentication specs

Use raw string in spec instead of interpolation

68fc7a5

cilim added review enhancement and removed review labels Oct 21, 2016

Update contributors

aff5864

Add devise import page to docs and update some examples with the Ruby…

e0a979e

… SDK documentation links

Merge branch 'master' into mc-sphinx-documentation

e195a79

cilim added the review pr label Nov 7, 2016

DamirSvrtan reviewed Nov 8, 2016

View reviewed changes

Fix typos and change yaml code block types to yaml

3cb9452

cilim added 2 commits November 8, 2016 11:32

Change app url in .travis

d0d2a3f

Merge branch 'master' into mc-sphinx-documentation

d033464

cilim merged commit 8fa1192 into master Nov 8, 2016

cilim deleted the mc-sphinx-documentation branch November 8, 2016 15:03

		sessions for you. No special configuration is necessary.

		To use cookie authentication, simply use the ``require_authentication!`` before callback:


		Here is an example configuration block, with the default settings:

		.. code-block:: ruby


		Opt-in to ``stormpath`` validation with this configuration:

		.. code-block:: ruby

Rails documentation in sphinx #57

Rails documentation in sphinx #57

Uh oh!

Conversation

cilim commented Sep 23, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Sep 23, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Sep 26, 2016

Uh oh!

coveralls commented Sep 28, 2016

Uh oh!

coveralls commented Sep 28, 2016

Uh oh!

coveralls commented Oct 25, 2016

Uh oh!

coveralls commented Nov 2, 2016

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

DamirSvrtan Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

coveralls commented Nov 8, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Nov 8, 2016

Uh oh!

cilim commented Nov 8, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cilim commented Sep 23, 2016 •

edited

Loading

coveralls commented Sep 23, 2016 •

edited

Loading

coveralls commented Nov 8, 2016 •

edited

Loading