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: Update self service reg docs #367

Merged
merged 2 commits into from
Apr 27, 2020

Conversation

Cohedrin
Copy link
Contributor

@Cohedrin Cohedrin commented Apr 26, 2020

Related issue

N/A

Proposed changes

  • Update links in user-registration-user-login docs to point at current url
    • /auth/browser/(login|registration) -> /self-service/browser/flows/requests/(login|registration)
  • Format json blob in same docs to be easier to read:
    before:

Screen Shot 2020-04-26 at 10 48 17 AM

after:

Screen Shot 2020-04-26 at 10 47 48 AM

Checklist

  • I have read the contributing guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security. vulnerability, I
    confirm that I got green light (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

Further comments

The old links pointed at /auth/browser/(login|registration)
which seems to be outdated now.

From the ui node code: https://github.com/ory/kratos-selfservice-ui-node/blob/489c76d1b0474ee55ef56804b28f54d8718747ba/src/routes/auth.ts#L28
and the api documentation for kratos https://www.ory.sh/kratos/docs/reference/api#get-the-request-context-of-browser-based-login-user-flows,
these seem to be incorrect.

The actual url hit is /self-service/browser/flows/requests/(login|registration).

The old links pointed at `/auth/browser/(login|registration)`
which seems to be outdated now.

From the ui node code: https://github.com/ory/kratos-selfservice-ui-node/blob/489c76d1b0474ee55ef56804b28f54d8718747ba/src/routes/auth.ts#L28
and the api documentation for kratos https://www.ory.sh/kratos/docs/reference/api#get-the-request-context-of-browser-based-login-user-flows,
these seem to be incorrect.

The actual url hit is `/self-service/browser/flows/requests/(login|registration)`.
This commit updates those links
This blob was previously one large inline string, which personally made
the docs a bit hard to read. This formats it into an (arguably) easier
to parse code block
@CLAassistant
Copy link

CLAassistant commented Apr 26, 2020

CLA assistant check
All committers have signed the CLA.

@Cohedrin Cohedrin changed the title Update self service reg docs docs: Update self service reg docs Apr 26, 2020
@aeneasr
Copy link
Member

aeneasr commented Apr 27, 2020

Superb, thanks!

@aeneasr aeneasr merged commit 4cf0323 into ory:master Apr 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants