Updated the Quick-start guide#191
Updated the Quick-start guide#191sushma-4 merged 17 commits intoapptainer:masterfrom sushma-4:master
Conversation
jchavezlavalle
left a comment
jchavezlavalle
left a comment
There was a problem hiding this comment.
left some comments around @sushma-4 thanks!
WestleyK
left a comment
WestleyK
left a comment
There was a problem hiding this comment.
Looks good, couple suggestions/questions...
Co-Authored-By: WestleyK <westley@sylabs.io>
Co-Authored-By: WestleyK <westley@sylabs.io>
GodloveD
left a comment
GodloveD
left a comment
There was a problem hiding this comment.
Thanks for these changes @sushma-4. I agree with most of them, but there are others I think should be reverted. I think the wget command should remain as a more efficient way to download singularity. Also I really don't think we want to replace internal links with external links. If we do so we will need to update all of the external links every time we update the docs versions or all of our links will be pointing to older versions of the docs. Better to just fix the internal references if they are busted.
GodloveD
left a comment
GodloveD
left a comment
There was a problem hiding this comment.
I still think the internal links should not be referencing an external URI. See my comments inline for details.
| building from source) you must remove all of these files and directories to | ||
| For example, in a standard installation of Singularity 3.0.1 and beyond (when | ||
| building from source) you must remove all of these files and directories to | ||
| completely remove Singularity. |
There was a problem hiding this comment.
| completely remove Singularity. |
This exact phrase was used in the sentence before. There isn't a need to repeat. One other note, to remain grammatically correct when removing this section of the sentence, we also need to remove the 'to' that proceeds it on the line right before.
End sentence should be "For example, in a standard installation of Singularity 3.0.1 and beyond (when building from source) you must remove all of these files and directories."
There was a problem hiding this comment.
Thanks for the review @GwendolynK
Does this sound better?
In a standard installation of Singularity 3.0.1 and beyond (when
building from source), the command sudo make install lists all the files as
they are installed. You must remove all of these files and directories to
completely remove Singularity.
| Singularity. | ||
| .. note:: | ||
| This is only a short manual for Quick Installation. For details on | ||
| different methods of installation, versions, and RPM etc, please refer to |
There was a problem hiding this comment.
| different methods of installation, versions, and RPM etc, please refer to | |
| different methods of installation, versions, RPMs, etc, please refer to |
@WestleyK is this still accurate technically? It is grammatically now...
There was a problem hiding this comment.
I'm referring to https://sylabs.io/guides/3.2/user-guide/installation.html#build-and-install-an-rpm on our installation page. It should be just RPM IMO
Co-Authored-By: GwendolynK <43799653+GwendolynK@users.noreply.github.com>
Co-Authored-By: GwendolynK <43799653+GwendolynK@users.noreply.github.com>
Co-Authored-By: GwendolynK <43799653+GwendolynK@users.noreply.github.com>
Co-Authored-By: GwendolynK <43799653+GwendolynK@users.noreply.github.com>
Co-Authored-By: GwendolynK <43799653+GwendolynK@users.noreply.github.com>
5 participants
Description of the Pull Request (PR):
Updated the quick guide so that the installation is described in the simplest way possible - compiling outside of GO etc. Also changed some command syntax supported by newer versions, updated the hyperlinks and interlinks to different sections of the docs.
This fixes or addresses the following GitHub issues:
Need to update Quickstart guide for v3.2 #188