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 Install Pages #12940

Merged
merged 10 commits into from
Jan 25, 2023
Merged

Docs Install Pages #12940

merged 10 commits into from
Jan 25, 2023

Conversation

kaitlincart
Copy link
Contributor

Copy edits to the following pages:

  • Install from source
  • Upgrade from 1.0
  • Uninstall

soapy1
soapy1 previously approved these changes Oct 6, 2022
However, beware of the following pitfalls:
You must install Ruby 2.2 or newer to develop and build Vagrant. The
specific Ruby version that you will need is documented in `vagrant.gemspec`, located in the repository on GitHub. It contains the most
up-to-date requirements.
Copy link
Contributor

Choose a reason for hiding this comment

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

These changes sound good but the new lines are a little wonky

Copy link
Member

@chrisroberts chrisroberts left a comment

Choose a reason for hiding this comment

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

Just a small change on the Ruby version referenced but looks great otherwise

website/content/docs/installation/source.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@tunzor tunzor left a comment

Choose a reason for hiding this comment

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

Some style suggestions but otherwise 👍

website/content/docs/installation/source.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/source.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/source.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/uninstallation.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/uninstallation.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/upgrading-from-1-0.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/upgrading-from-1-0.mdx Outdated Show resolved Hide resolved
Co-authored-by: Anthony <russo555@gmail.com>
tunzor
tunzor previously approved these changes Oct 12, 2022
website/content/docs/installation/source.mdx Outdated Show resolved Hide resolved
in `vagrant.gemspec`, located in the repository on GitHub.
It contains the most up-to-date requirements.

~> **Note:** It is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
~> **Note:** It is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby.
~> **Note:** We do not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby.

Copy link
Member

Choose a reason for hiding this comment

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

This note can be discarded now. This is less of an issue anymore now that recent rubies are generally available via system packages.

website/content/docs/installation/source.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/uninstallation.mdx Outdated Show resolved Hide resolved
website/content/docs/installation/upgrading-from-1-0.mdx Outdated Show resolved Hide resolved
Copy link
Member

@chrisroberts chrisroberts left a comment

Choose a reason for hiding this comment

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

Looks great. One note that should probably be dropped.

in `vagrant.gemspec`, located in the repository on GitHub.
It contains the most up-to-date requirements.

~> **Note:** It is not recommended that you use the system Ruby. You need a Ruby version manager like RVM or chruby.
Copy link
Member

Choose a reason for hiding this comment

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

This note can be discarded now. This is less of an issue anymore now that recent rubies are generally available via system packages.

Co-authored-by: Anthony <russo555@gmail.com>
@ashleemboyer
Copy link
Contributor

Hello @kaitlincart! 😊 This is a quick comment to let you know I've updated this PR with main so it's up to date with the changes made in #13048.

soapy1
soapy1 previously approved these changes Jan 23, 2023
Copy link
Contributor

@soapy1 soapy1 left a comment

Choose a reason for hiding this comment

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

lgtm

the `vagrant.gemspec` in the repository on GitHub, as it will contain the most
up-to-date requirement. This guide will not discuss how to install and manage Ruby.
However, beware of the following pitfalls:
You must install Ruby 2.7 or newer to develop and build Vagrant. The
Copy link
Contributor

Choose a reason for hiding this comment

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

Currently Vagrant needs Ruby between 3.0 - 3.2. This will keep changing, so this can probably be a bit more vague and continue to reference the vagrant.gemspec to provide the most up to date info on Ruby version.

Copy link
Member

@chrisroberts chrisroberts left a comment

Choose a reason for hiding this comment

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

👍

@kaitlincart kaitlincart merged commit 2f5b5f0 into main Jan 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport/website Backport changes into `stable-website` documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants