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: change model to schema #1639

Merged
merged 10 commits into from
Aug 10, 2021
Merged

docs: change model to schema #1639

merged 10 commits into from
Aug 10, 2021

Conversation

vinckr
Copy link
Member

@vinckr vinckr commented Aug 9, 2021

Related issue(s)

This PR changes the term Identity Model to Identity Schema;
capitalizing it in all instances, since it is an Ory specific term and will be documented in a glossary soon.

Changes have been made for the next and 0.7 versions.

Also changed instances of
Identity JSON Schema
Identity Schema JSON
JSON Schemas for Identities
to
Identity Model

Have tested with npm run build and found no broken links.

This commit e6d420a makes the required changes in API documentation. (Please let me know if this is the correct location).

Checklist

Further Comments

@vinckr vinckr marked this pull request as ready for review August 9, 2021 14:03
Comment on lines -2 to +3
id: identity-data-model
title: Identity Data Model
id: identity-schema
title: Identity Schema
Copy link
Member

Choose a reason for hiding this comment

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

What does the SEO say? 🤔 🦊

Copy link
Member Author

@vinckr vinckr Aug 9, 2021

Choose a reason for hiding this comment

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

If I search for Identity Data Model our doc is placed 2.
For Identity Schema we are in place 3 (just after ms azure docs ;) )

Copy link
Member Author

Choose a reason for hiding this comment

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

Is there anything else I didn't consider?
We probably have to add the old
identity-data-models to https://github.com/ory/web/blob/master/static/_redirects ?

Copy link
Member

Choose a reason for hiding this comment

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

I don't know much about SEO, but changing URLs is always not as easy as just changing it.

Copy link
Member

Choose a reason for hiding this comment

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

@codecov
Copy link

codecov bot commented Aug 9, 2021

Codecov Report

Merging #1639 (73ba15a) into master (57f2731) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 73ba15a differs from pull request most recent head d50a5ff. Consider uploading reports for the commit d50a5ff to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1639      +/-   ##
==========================================
- Coverage   74.27%   74.25%   -0.02%     
==========================================
  Files         259      259              
  Lines       12618    12618              
==========================================
- Hits         9372     9370       -2     
- Misses       2626     2627       +1     
- Partials      620      621       +1     
Impacted Files Coverage Δ
persistence/sql/persister_courier.go 85.00% <0.00%> (-3.34%) ⬇️

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 dc32720...d50a5ff. Read the comment docs.

Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

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

LGTM :)

Comment on lines -2 to +3
id: identity-data-model
title: Identity Data Model
id: identity-schema
title: Identity Schema
Copy link
Member

Choose a reason for hiding this comment

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

@vinckr
Copy link
Member Author

vinckr commented Aug 10, 2021

PR for the redirects:
https://github.com/ory/web/pull/330

@aeneasr
Copy link
Member

aeneasr commented Aug 10, 2021

Thank you!

@aeneasr aeneasr merged commit 09c403e into ory:master Aug 10, 2021
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.

None yet

3 participants