Closed
Conversation
Add optional information on how to install Go via gvm Add variable to reference golint version to be installed * This prevents us from hardcoding a version in the setup doc. Add makefile.md documentation * Seperating this simplifies our primary dev-env-setup document. Add bash environment helpers documentation Update dev-setup docs relocating Debian and Mac OS dependencies * They should be grouped under all OS specific dependencies to be installed. Fix formatting issues
…local rp development The primary setup document was getting very cluttered. This helps it to be more easily read and understood.
|
Skipping CI for Draft Pull Request. |
komidore64
reviewed
Mar 11, 2026
Comment on lines
+2
to
+9
| - [Bash Environment Helpers](#bash-environment-helpers) | ||
| - [ARO-RP Bash Environment Helpers](#aro-rp-bash-environment-helpers) | ||
| - [Helper Aliases and Functions](#helper-aliases-and-functions) | ||
| - [Aliases](#aliases) | ||
| - [Functions](#functions) | ||
| - [Bash rc config Drop-Ins](#bash-rc-config-drop-ins) | ||
| - [bashrc.d Setup](#bashrcd-setup) | ||
| - [bashrc Drop-Ins Testing](#bashrc-drop-ins-testing) |
Collaborator
There was a problem hiding this comment.
I wanted to note that GitHub auto-generates a TOC for rendered markdown files.
Then we don't have to maintain a TOC, or forget to update it which results in dead anchor links.
Collaborator
Author
There was a problem hiding this comment.
This is true.
I personally render and read markdown docs locally in vscode... so I appreciate having the TOC still present.
Collaborator
Author
|
Changes are included in #4680 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Which issue this PR addresses:
https://issues.redhat.com/browse/ARO-25110
What this PR does / why we need it:
Updates and consolidates our development environment setup documentation.
Test plan for issue:
I've locally tested the bash helpers in my Fedora development environment.
Is there any documentation that needs to be updated for this PR?
Docs are in this PR.
How do you know this will function as expected in production?
N/A development environment doc updates.