Feature/getting started improvements #53
Conversation
It was frustrating to try to start quickly via the Quick Start and not have any idea where to find an image. There are hints in the README in the repo, but it's convenient to have them here. I pulled the content from the README.md and referenced it and the tutorials section. "Someone" should probably work up a posse of examples for the Linux Flavors du jour.
Make the examples consistent-ish with the examples in the README.md by adding the traditional '$' shell prompt where appropriate.
As in the earlier commit, add shell prompts to the lines in the example, making them consistent with other examples here and in the README.md.
pages/docs/overview/start.md
Outdated
|
|
||
| It's easiest to build an image on a "compatible" host. Here's a quick | ||
| recipe to build a CentOS 7 image on a CentOS host. See | ||
| the [bootstrapping section][readme-bootstrapping] of the README for |
There was a problem hiding this comment.
you'll have to put the full URL to the README here, this will likely lead to a 404.
pages/docs/overview/start.md
Outdated
| recipe to build a CentOS 7 image on a CentOS host. See | ||
| the [bootstrapping section][readme-bootstrapping] of the README for | ||
| the full story and the [tutorials] for deeper advice. | ||
|
|
pages/docs/overview/start.md
Outdated
| MirrorURL: http://mirror.centos.org/centos-%{OSVERSION}/%{OSVERSION}/os/$basearch/ | ||
| Include: yum | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I really like this change to the Quickstart, but instead of doing Centos 7, could we do a technology that more users are familiar with, Docker? So provide an example of Bootstrap: docker and then maybe point the user to the folder of example specs for others.
pages/docs/overview/start.md
Outdated
| DISTRIB_ID=Ubuntu | ||
| DISTRIB_RELEASE=14.04 | ||
| DISTRIB_CODENAME=trusty | ||
| DISTRIB_DESCRIPTION="Ubuntu 14.04 LTS" | ||
| ```` | ||
|
|
||
| {% include links.html %} | ||
|
|
||
| [readme-bootstrapping]: https://github.com/singularityware/singularity/blob/master/README.md#bootstrapping-new-images |
There was a problem hiding this comment.
oh oups, disregard my previous comment... forgot about this :)
|
I built a CentOS image because the rest of the examples on that page refer to a CentOS image. I think that you're suggesting above that instead of providing an example that uses I can see how that would be more generically useful. I'll rework this tonight. |
|
Sweet! Yes I love it. Showing after that the bootstrap spec would still be ok, because the user would see that there are many ways to skin a cat. The common use of centOS is because there is this weird guy (cough cough @gmkurtzer) that like, made it or something? He's wandering the halls of documentation for Singularity and putting it everywhere... we should find him and give him some oatmeal or something. :p |
|
I'll see what I can whip up over the weekend. I'm all about CentOS at work (and FreeBSD when I let my hair down) but I do like to keep an open mind.... |
|
I hope your mind is open... my go to is Ubuntu! I'm pretty sure it's just because it's purple. 💜 |
Pulling an existing image from Docker Hub will make it easier for a wider range of Linux users to get going quickly. Rework the demo to import a CentOS 7 image. Give a few other popular Linuxes a shout out and refer to the Singularity and Docker page.
|
Beastie's usually red, but it's open minded too... 😈 . This update calls out some of the other Linuxes too. |
|
hey @hartzell do you still want to make these changes? If you want to rebase with master (or PR to docs/2.4 is relevant) we can revisit. |
|
Hi @vsoch -- Yes, I'll pick this back up. I'm working on this sporadically for now. I appreciate your patience. |
|
Of course! There really isn't a rush, I just wanted to touch bases. Chat when we do! :) |
I found the quick start frustrating because I had no idea how to create an image.
I eventually found a simple recipe in the repo's README.md.
This PR duplicates it in the quick start section. It's CentOS specific but it gives pointers to additional info and discussion.
Also, minor edits so that all of the examples showed similar shell prompts.