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: Fix subject identifier algorithms to match configuration #2400

Merged
merged 2 commits into from
Mar 11, 2021
Merged

docs: Fix subject identifier algorithms to match configuration #2400

merged 2 commits into from
Mar 11, 2021

Conversation

LemurP
Copy link
Contributor

@LemurP LemurP commented Mar 10, 2021

On https://www.ory.sh/hydra/docs/reference/configuration/ under 'subject identifiers' the name for defining which subject identifier algorithms are supported it is called "supported_types", not "enabled" as in these pages.

Testing shows that "supported_types" is the correct value for use in Hydra.

Related issue

No related issue

Proposed changes

Update documentation page to match reality

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 page I have made a change to created some confusion when we enabled pairwise subject identifiers.
I don't care to read all the policies, as it is a miniscule change. Sorry.

On https://www.ory.sh/hydra/docs/reference/configuration/ under 'subject identifiers' the name for defining which subject identifier algorithms are supported it is called "supported_types", not "enabled" as in these pages.

Testing shows that "supported_types" is the correct value for use in Hydra.
@CLAassistant
Copy link

CLAassistant commented Mar 10, 2021

CLA assistant check
All committers have signed the CLA.

@LemurP LemurP changed the title Fix subject identifier algorithms to match configuration docs: Fix subject identifier algorithms to match configuration Mar 10, 2021
@aeneasr
Copy link
Member

aeneasr commented Mar 11, 2021

Thank you very much for your contribution to the documentation! Due to the way Docusaurus versioning works, you need to make the changes in two locations:

  • docs/versioned_docs/version-v{version}/path/to/file
  • docs/docs/path/to/file

Without making them in both locations, the changes will most likely be lost when releasing another version. Thank you! :)

Needed to be added to
* docs/versioned_docs/version-v{version}/path/to/file
* docs/docs/path/to/file
@LemurP
Copy link
Contributor Author

LemurP commented Mar 11, 2021

I've made the same change in the docs/docs/path/to/file now.

Hope that's all that is needed. :)

@aeneasr
Copy link
Member

aeneasr commented Mar 11, 2021

Awesome, thank you! 🎉 Your contribution makes Ory better :)

@aeneasr aeneasr merged commit dd19b86 into ory:master Mar 11, 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