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

doc: clarify Boxstarter behavior on install tools #24000

Conversation

ferventcoder
Copy link
Contributor

Clarify the behavior of what Boxstarter may do when it runs on a box
to install all the necessary tools so that there are no surprises to
the end user when the script is run.

Currently there is no interface that warns the user that Boxstarter will
reboot the machine possibly multiple times depending on how many
dependencies need to be installed and doesn't mention a need to disable
UAC. For folks who see what may look like a reboot loop, we feel it is
necessary to make them aware that UAC will be disabled and they will need
to take action to re-enable UAC manually if they interfere/stop the script
from finishing.

Checklist

References #23838

Clarify the behavior of what Boxstarter may do when it runs on a box
to install all the necessary tools so that there are no surprises to
the end user when the script is run.

Currently there is no interface that warns the user that Boxstarter will
reboot the machine possibly multiple times depending on how many
dependencies need to be installed and doesn't mention a need to disable
UAC. For folks who see what may look like a reboot loop, we feel it is
necessary to make them aware that UAC will be disabled and they will need
to take action to re-enable UAC manually if they interfere/stop the script
from finishing.
@nodejs-github-bot nodejs-github-bot added install Issues and PRs related to the installers. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform. labels Oct 31, 2018
cls
echo !!!!!WARNING!!!!!
echo -----------------
echo Use of Boxstarter may reboot your box automatically multiple times. When
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit-picking a bit, but "reboot your box" is rather colloquial. "reboot your computer" or something like that is probably preferable.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me!

echo !!!!!WARNING!!!!!
echo -----------------
echo Use of Boxstarter may reboot your box automatically multiple times. When
echo performing a reboot, Boxstarter will need to disable UAC to allow the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth it to spell out what UAC refers to? Or are most Windows users going to know?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a developer using Windows, I guess you should know what it means. Looks much better now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this was fixed up by @joaocgreis

@joaocgreis
Copy link
Member

Thanks for opening this PR! I included this in #23987 as discussed there.

@ferventcoder
Copy link
Contributor Author

Closed in favor of including this with #23987.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
install Issues and PRs related to the installers. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants