-
-
Notifications
You must be signed in to change notification settings - Fork 710
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: mention OS environment, Debian Stretch #3157
Conversation
I was trying to see if there was a better place in the Docs to mention this, but there really isn't. This seems like a fine place to note it to me. https://docs.sandstorm.io/en/latest/vagrant-spk/design/ might be a good spot, but it's kinda a historic text, rather than a current document. https://docs.sandstorm.io/en/latest/vagrant-spk/customizing/ might be a good spot, although as noted in our discussion, it's not something easy to "customize" or change, but from the title "Understanding" and customizing vagrant-spk, that explains how vagrant-spk works, it might be an alright place. |
What about https://docs.sandstorm.io/en/latest/vagrant-spk/installation/?
Perhaps replace "In this tutorial," with "By default,"? |
"By default" would suggest you can change it. And in the case of vagrant-spk, you really can't. Though your Node stack changes are release-independent, so if the other stacks were updated similarly, it might be a bit easier in the future to change platforms. |
yep, that's what I thought as well; what about removing "In this tutorial,"? It sort of implies that Debian is only used in the tutorial, despite being the only option (unless user fork the entire vagrant-spk). What do you think of mentioning Debian in the Installation tutorial instead, I'm assuming most users read that before "Platform Stacks" page. |
I am kinda thinking in the Overview of https://docs.sandstorm.io/en/latest/vagrant-spk/customizing/ is the best place, as it goes into detail about what vagrant-spk does and how it works, particularly in the section about what different files in it are for. I don't think the intention was for users to need to know or care what vagrant-spk was running in the background (as in many cases, vagrant-spk users may be Mac or Windows users who are not super opinionated about Linux distros). |
If users are fine with the default stacks, indeed there's no need to know about the distro. But it's essential for I changed it to Overview of https://docs.sandstorm.io/en/latest/vagrant-spk/customizing/. |
d553bd5
to
a0f0816
Compare
https://github.com/sandstorm-io/vagrant-spk/blob/4d16fb17583c946753e49b1877d41e5e2d18b2dd/vagrant-spk#L73