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: Update README.md Windows instructions #1077

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

matthewpereira
Copy link
Contributor

Through user testing I observed developers struggling to get Auth0 CLI working properly on Windows machines. I've updated the install instructions (Powershell in particular) to provide the instructions that have so far been successful.

🔧 Changes

  • Unify Linux and macOS instructions, with brew listed first and cURL instructions listed next.
  • Separate Powershell instructions into separate instructions
  • Provide more explicit instructions on how to set PATH and HOME environment variables successfully
  • Remind users to restart Powershell so that it will use latest environment variables
  • Formatted tips with > [!TIP] syntax

🔬 Testing

  1. Follow instructions verbatim on a Windows PC, or
  2. Witness a user doing Add github CI #1

📝 Checklist

  • [N/A] All new/changed/fixed functionality is covered by tests (or N/A)
  • [N/A] I have added documentation for all new/changed functionality (or N/A)

* Unify Linux and OSX instructions where possible
* Separate powershell instructions
* Provide more explicit instructions on PATH and HOME
* Remind users to restart Powershell
* Format tips with Github [!TIP] syntax
@developerkunal developerkunal merged commit 01a8ebc into auth0:main Sep 20, 2024
10 checks passed
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.

2 participants