Clarify the runtime directory location in installation docs #6624
Conversation
There was a problem hiding this comment.
The HELIX_RUNTIME and symlink options both allow you to install the Helix repo anywhere. Giving instructions that use ~/src explicitly makes it seem like it must be installed there which isn't the case and I think different people like to put their source code in different places.
So I think the runtime instructions for linux should just be more explicit about "the directory where the Helix repository is cloned." Mentioning ~/src as an example is ok but I think we should avoid hard-coding it in the instructions.
There was a problem hiding this comment.
The repository_directory placeholder looks like a regular directory name to me and I think that makes this more confusing. Instead I think we should keep the instructions mostly as-is and focus on the confusing parts of the HELIX_RUNTIME and ln steps: replacing the example absolute path and ensuring that we have cdd into the clone's directory.
pascalkuthe
added
the
S-waiting-on-author
|
Please see #6809 , I have not addressed any of the things mentioned here on purpose, but please rebase when/if my PR gets merged as it changes some things around. |
|
As of time speaking #6809 is still Open. I have attempted to synthesise directions from both @David-Else and @the-mikedavis. |
There was a problem hiding this comment.
#6809 has been merged. Could you rebase or merge master to put this on top of those changes?
|
@David-Else Do I need to do anything more regarding this PR? |
|
I know I didn't create a local branch as I thought this would be so trivial, but we should be good to go now. |
the-mikedavis
changed the title
the-mikedavis
removed
the
S-waiting-on-author
the-mikedavis
added
the
S-waiting-on-review
…itor#6624) * runtime config made clearer * following Unix FHS * we probably want to install Helix as a regular user without sudo access * suggestions adopted from @the-mikedavis * attempted to synthesise comments given * capitalisation of second header * required changes hopefully made * we should have a match now * Linux windows dir match
…itor#6624) * runtime config made clearer * following Unix FHS * we probably want to install Helix as a regular user without sudo access * suggestions adopted from @the-mikedavis * attempted to synthesise comments given * capitalisation of second header * required changes hopefully made * we should have a match now * Linux windows dir match
…itor#6624) * runtime config made clearer * following Unix FHS * we probably want to install Helix as a regular user without sudo access * suggestions adopted from @the-mikedavis * attempted to synthesise comments given * capitalisation of second header * required changes hopefully made * we should have a match now * Linux windows dir match
…itor#6624) * runtime config made clearer * following Unix FHS * we probably want to install Helix as a regular user without sudo access * suggestions adopted from @the-mikedavis * attempted to synthesise comments given * capitalisation of second header * required changes hopefully made * we should have a match now * Linux windows dir match
…itor#6624) * runtime config made clearer * following Unix FHS * we probably want to install Helix as a regular user without sudo access * suggestions adopted from @the-mikedavis * attempted to synthesise comments given * capitalisation of second header * required changes hopefully made * we should have a match now * Linux windows dir match
#6607