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 troubleshooting for scripts #342

Merged
merged 5 commits into from
Feb 20, 2024
Merged

Conversation

nemanja-drobac
Copy link
Contributor

Description

Add latest fix for running setup with BASH.

@nemanja-drobac nemanja-drobac requested a review from a team as a code owner December 12, 2023 14:59
@nemanja-drobac nemanja-drobac linked an issue Dec 12, 2023 that may be closed by this pull request
Copy link
Member

@hknutsen hknutsen left a comment

Choose a reason for hiding this comment

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

The instructions you've added are specifically for installing prerequisites and running the script on Windows, however the use of the word Bash implies that we're talking about a Unix-like system. Guessing this is a result of the script being run in Git Bash. I think that if these instructions are to be added, there should be made a very clear distinction between instructions for Bash (Unix) and Git Bash (Windows). I would probably replace the use of Git Bash with PowerShell for Windows-specific instructions myself, since it's the Windows-native shell, but feel free to disagree.

I added some suggestions that I think could make more sense, while still keeping your changes.

Also, according to this repos contributing guidelines, the PR title should not specify a scope, and the type should be chore, e.g. chore: add OIDC script troubleshooting or chore: oidc.sh troubleshooting

nemanja-drobac and others added 2 commits December 13, 2023 11:41
Co-authored-by: Henrik Simonsen Knutsen <[email protected]>
Co-authored-by: Henrik Simonsen Knutsen <[email protected]>
chbul
chbul previously approved these changes Dec 15, 2023
Copy link
Contributor

@chbul chbul left a comment

Choose a reason for hiding this comment

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

Looks good

@hknutsen hknutsen changed the title docs(oidc): add bash info docs: clarify OIDC script usage Feb 2, 2024
@hknutsen
Copy link
Member

hknutsen commented Feb 2, 2024

Updated PR title according to contributing guidelines.

@hknutsen hknutsen changed the title docs: clarify OIDC script usage docs: add troubleshooting for scripts Feb 20, 2024
@hknutsen hknutsen requested a review from a team February 20, 2024 07:33
@hknutsen hknutsen requested a review from chbul February 20, 2024 08:18
@hknutsen hknutsen dismissed their stale review February 20, 2024 11:00

Suggestions addressed outside of conversation.

@hknutsen hknutsen merged commit f88c0c1 into main Feb 20, 2024
7 checks passed
@hknutsen hknutsen deleted the 341-docsoidc-add-bash-info branch February 20, 2024 12:26
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.

docs(oidc): add bash info
4 participants