-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: update bash_completion directory typo #5418
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
Conversation
Correct directory is: `/etc/bash_completion.d` For `sudo hasura completion bash --file=/etc/bash_completion.d/hasura`. Current typo in the docs refers to non-existent directory `bash.completion.d` Reflects install tested on Ubuntu 20.04 LTS
|
Beep boop! 🤖 Hey @slimlime, thanks for your PR! One of my human friends will review this PR and get back to you as soon as possible. Stay awesome! 😎 |
|
Deploy preview for hasura-docs ready! Built with commit 3a668ac |
|
@slimlime thank you for your contribution 🙂 could you please sign the CLA? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey thanks for the contribution, a small concern though. The CLI docs are generated based on the help text, so I think we should probably make this change here:
graphql-engine/cli/commands/completion.go
Line 15 in 788095a
| $ sudo hasura completion bash --file=/etc/bash.completion.d/hasura |
Thank you for pointing out the command line lines and additional context. Will add those edits in graphql-engine/cli/commands/completion.go and a changelog.md with a concise oneliner outlining the help text update as required Also noted a few other occurrences in the Will add those other occurrences as well (Windows (Git Bash)) |
|
@slimlime No need to add to the changelog. I added the |
Update completion.go help text directory to propagate the docs changes noted in the published manual here docs/graphql/manual/hasura-cli/hasura_completion.rst#L30
slimlime
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
completion.go help text to propagate to the generated hasura_completion docs
|
Review app for commit 682911c deployed to Heroku: https://hge-ci-pull-5418.herokuapp.com |
|
Review app for commit 561ca7f deployed to Heroku: https://hge-ci-pull-5418.herokuapp.com |
|
Review app for commit a17a652 deployed to Heroku: https://hge-ci-pull-5418.herokuapp.com |
|
Review app for commit 3a668ac deployed to Heroku: https://hge-ci-pull-5418.herokuapp.com |
|
Review app https://hge-ci-pull-5418.herokuapp.com is deleted |
|
Beep boop! 🤖 Awesome work @slimlime! All of us at Hasura ❤️ what you did. Thanks again 🤗 |
|
@slimlime thank you so much for your contribution 🙏 as a thank you, we'd love to send you some swag. If you're interested, please send an email to marion@hasura.io, and we'll take it from there 🙂 |
Quick typo update.
Correct directory is:
/etc/bash_completion.dFor
sudo hasura completion bash --file=/etc/bash_completion.d/hasura. Current typo in the docs refers to non-existent directorybash.completion.dReflects install tested on Ubuntu 20.04 LTS
Description
Changelog
CHANGELOG.mdis updated with user-facing content relevant to this PR. If no changelog is required, then add theno-changelog-requiredlabel./etc/bash_completion.dAffected components
Related Issues
Solution and Design
Steps to test and verify
Limitations, known bugs & workarounds
Server checklist
Catalog upgrade
Does this PR change Hasura Catalog version?
Breaking changes