Skip to content
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

Merged
merged 1 commit into from
Jan 20, 2020

Conversation

@ocdtrekkie
Copy link
Collaborator

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.

@curbengh
Copy link
Contributor Author

What about https://docs.sandstorm.io/en/latest/vagrant-spk/installation/?

In this tutorial, we use VirtualBox to emulate a computer on which we run Debian 9 (Stretch), controlled via Vagrant.

Perhaps replace "In this tutorial," with "By default,"?

@ocdtrekkie
Copy link
Collaborator

"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.

@curbengh
Copy link
Contributor Author

curbengh commented Sep 17, 2019

"By default" would suggest you can change it. And in the case of vagrant-spk, you really can't.

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.

@ocdtrekkie
Copy link
Collaborator

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).

@curbengh
Copy link
Contributor Author

curbengh commented Sep 20, 2019

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 diy stack, i.e. adding 3rd-party apt repo, so they need to know which distro and its version is used.

I changed it to Overview of https://docs.sandstorm.io/en/latest/vagrant-spk/customizing/.

@curbengh curbengh force-pushed the debian branch 2 times, most recently from d553bd5 to a0f0816 Compare September 20, 2019 12:14
@ocdtrekkie ocdtrekkie added the documentation Documentation issues label Jan 15, 2020
@ocdtrekkie ocdtrekkie merged commit 77a114c into sandstorm-io:master Jan 20, 2020
@curbengh curbengh deleted the debian branch February 17, 2020 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants