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

grammatically incorrect and confusing summary #793

Open
artcathcl opened this issue Mar 25, 2024 · 5 comments
Open

grammatically incorrect and confusing summary #793

artcathcl opened this issue Mar 25, 2024 · 5 comments

Comments

@artcathcl
Copy link

artcathcl commented Mar 25, 2024

Description

The noted sentence is grammatically incorrect (minor issue), but also is not clear.

Observed

The test says:

OAuth Provider is an identity service uses an existing identity service as a authentication source to create an OAuth Server for authentication and authorization.

Desired

I'm not really sure what it should say, but here's where things are confusing:

  1. OAuth Provider is an identity service uses an ... this just doesn't make sense. Maybe just missing words. I think maybe it's trying to say this, but please double check with experts to confirm: The OAuth Provider identity service type is used to create an OAuth Server leveraging an existing identity service (e.g. user store) for authentication and authorization.
  2. uses an existing identity service as a authentication source ... a should be an ... but maybe rewriting the whole sentence will fix that anyway :)

Topics

https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Identity11_OAuth.html

To Reproduce

NA, this is just a documentation issue.

@kumari-h
Copy link
Contributor

kumari-h commented Apr 1, 2024

Hi @artcathcl: Who shall be the expert from the engineering team on this technical topic to verify the accuracy of this information?

@kumari-h
Copy link
Contributor

kumari-h commented Apr 1, 2024

Hi @artcathcl, I've opened this JIRA ticket to address this issue: https://jira01.hclpnp.com/browse/MXOP-10436.
We'll catch up on JIRA.

Thanks!

(cc: @davidsayer57 )

@kumari-h
Copy link
Contributor

kumari-h commented Apr 19, 2024

Hi @artcathcl, I've planned this task for the Sprint 130 (current sprint). I'll complete & close this task during this sprint.

(@davidsayer57 )

@kumari-h
Copy link
Contributor

Hi @artcathcl, I've re-written the given content & removed the unnecessary words. The update is available at PR: https://github01.hclpnp.com/phoenix-temenos/volt-mx-doc-opnsrc/pull/2472.

Just a little bit, I'll share the preview doc page so you can verify.
JIRA ticket: https://jira01.hclpnp.com/browse/MXOP-10436

(@davidsayer57 )

@kumari-h
Copy link
Contributor

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

No branches or pull requests

2 participants