linkedin / linkedin/dr-elephant
Update jvm_props to jvm_args in wiki
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.4k
- Forks
- 839
- PR merge metrics
- No merged PRs in 30d
Description
The variable name was changed in [PR 4](https://github.com/linkedin/dr-elephant/pull/4/files#diff-81165fc8abb0ab49496bbf329e9efeedc7df0e667f85b4dcfa5c77f6f2c2e799).
But the [Wiki Quick Setup](https://github.com/linkedin/dr-elephant/wiki/Quick-Setup-Instructions-(Must-Read)) still uses the old name.
Please update the Wiki to use `jvm_args`. I tried to find if I can send a PR for this, but seems like Wiki cannot be forked by external users. If I have missed something & if it'd help if I send a PR, please point to how I can do it & I'll be happy to raise a PR too.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Wiki Quick Setup page linked in the issue and search for `jvm_props`. Update that reference to `jvm_args`, then reread the setup instructions to confirm the old variable name no longer appears.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100