Add system path tip to local contribution guide #1064
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a tip after the tabbed steps to run `docs-builder` from anywhere.
reakaleek
reviewed
Apr 9, 2025
docs/contribute/locally.md
Outdated
| :::: | ||
|
|
||
| :::{tip} | ||
| Place the `docs-builder` binary file in a directory and add its path to the system paths to run it from any folder. On macOS, edit the paths file by running `sudo nano /etc/paths`. |
There was a problem hiding this comment.
What do you think about suggesting to move the binary to /usr/local/bin ?
There was a problem hiding this comment.
It's what I've done locally, but I wonder if tampering with that folder wouldn't be frowned upon by, say, IT. :-S
There was a problem hiding this comment.
Good question. I'm putting all my binaries to that folder 🤷.
I did some quick Google search and storing a custom binary in /usr/local/bin seems to be the most common suggestion.
There was a problem hiding this comment.
Let's do that. I'll edit the tip with a sudo mv command.
There was a problem hiding this comment.
Cool. Thank you for the contribution!
reakaleek
approved these changes
Apr 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a tip after the tabbed steps to run
docs-builderfrom anywhere.