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: add long flag --grant-types in 5min tutorial #2650

Merged
merged 1 commit into from
Jul 30, 2021

Conversation

Delapouite
Copy link
Contributor

Hi

Short flag like -g are handy in an interactive context when a veteran user has to type long commands again and again.

Here, this tutorial is a entry point for someone discovering the hydra CLI and it's not obvious yet that it refers the to --grant-types.
Also it's more consistent with the following snippet on the same page that uses --grant-types explicitly.

Thanks

@CLAassistant
Copy link

CLAassistant commented Jul 26, 2021

CLA assistant check
All committers have signed the CLA.

@aeneasr
Copy link
Member

aeneasr commented Jul 29, 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! :)

Short flag like `-g` are handy in an interactive context when a veteran user has to type long commands again and again.

Here, this tutorial is a entry point for someone discovering the `hydra` CLI and it's not obvious yet that it refers the to `--grant-types`.
Also it's more consistent with the following snippet on the same page that uses `--grant-types` explicitly.
@Delapouite
Copy link
Contributor Author

Thanks for the hint. Code has been adjusted in the 2 locations now.

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.

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

@aeneasr aeneasr merged commit 4083684 into ory:master Jul 30, 2021
@Delapouite Delapouite deleted the patch-1 branch July 30, 2021 09:21
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