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.

Sign up for GitHub

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

Jump to bottom

Add HCP-Vagrant docs section with Migration Guide & Troubleshooting pages #13385

Merged
merged 5 commits into from
May 2, 2024
Merged

Add HCP-Vagrant docs section with Migration Guide & Troubleshooting pages #13385

merged 5 commits into from
May 2, 2024
+123 −2

Conversation

tehut
Copy link
Contributor

@tehut tehut commented May 1, 2024

This PR adds two doc pages.

I made a few changes from the google doc specifically

  • adding a note banner to the top of the migration guide to highlight our impending site migration
  • dropped the screenshots. First because resolving the image path was frustrating but primarily because that would bring the guide more into alignment with the rest of the docs site and because the migration tool is so straight forward that the screenshots weren't terribly helpful.

@hashicorp-cla-app HashiCorp CLA App
Copy link

hashicorp-cla-app bot commented May 1, 2024 •
edited

CLA assistant check
All committers have signed the CLA.

@hashicorp-cla-app HashiCorp CLA App
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

@tehut tehut requested a review from kaitlincart May 1, 2024 02:59
kaitlincart
kaitlincart reviewed May 1, 2024
View reviewed changes
website/content/vagrant-cloud/hcp-vagrant/migration-guide.mdx
Your HCP account must use the email address associated with your Vagrant Cloud account.Check under `Settings→ Profile` if you are unsure what email address you use for Vagrant Cloud.

1. Sign up for a (free) [HCP account](https://portal.cloud.hashicorp.com/orgs/create), with your primary Vagrant Cloud organization email address. You must verify your account and sign in to HCP.
2. At first log-in, use the wizard to create an HCP organization.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is "wizard" the language HCP uses?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, it doesn't refer to itself. It forces you to walk through the steps upon login.

@tehut @kaitlincart
Apply suggestions from Kait's review
b692ba5 
Co-authored-by: kaitlincart <43049322+kaitlincart@users.noreply.github.com>
chrisroberts
chrisroberts requested changes May 2, 2024
View reviewed changes
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.

This looks really great. Couple notes and some addresses/urls that need to be updated.

website/content/vagrant-cloud/hcp-vagrant/migration-guide.mdx Outdated

HCP [Vagrant Registry](https://portal.cloud.hashicorp.com/vagrant/discover), like Vagrant Cloud, is a public, searchable index of Vagrant boxes that allows box owners to host and share artifacts.

To take advantage of shared infrastructure and platform investments available on the Hashicorp Cloud Platform (HCP), Hashicorp is migrating all existing boxes to HCP Vagrant Registry and retiring the current Vagrant Cloud rails app at the end of July 2024.
Copy link
Member

Choose a reason for hiding this comment

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

I think you can replace rails app with just application here.

website/content/vagrant-cloud/hcp-vagrant/migration-guide.mdx Outdated

Once you have signed into both your HCP and Vagrant Cloud accounts, you can access the [migration tool](https://app.vagrantup.com/migration).

To auto-populate the migration tool with a specific Vagrant Cloud `Organization` click on the `Migrate to HCP` button in the top right corner of your [settings](https://app.vagrantup.com/settings) page.
Copy link
Member

Choose a reason for hiding this comment

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

I think this line can be dropped. The auto-selected organization thing is really only useful for the button in the settings.

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, I also removed a reference to auto-population two lines below this to be consistent.

website/content/vagrant-cloud/hcp-vagrant/migration-guide.mdx Outdated

## Conclusion

If for some reason you are unable to access your new HCP Registry or your migration does not complete successfully, review the [Migration Troubleshooting] (/vagrant/vagrant-cloud/hcp-vagrant/troubleshooting) guide or contact us at [support@hashicorp.com](mailto:support@hashicorp.com) with the subject `HCP Vagrant Migration`. Our team will be happy to help you complete your migration or reset your organization state.
Copy link
Member

Choose a reason for hiding this comment

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

The email address used here should be: support+vagrantcloud@hashicorp.com

website/content/vagrant-cloud/hcp-vagrant/troubleshooting.mdx Outdated

### Retrying Migrations

If a migration fails, a `retry` icon will appear beside the name of that organization on the [migration status](https://app.beta.vagrantup.com/migration/status) page. Failed migrations can be retried once.
Copy link
Member

Choose a reason for hiding this comment

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

URL needs to be updated to the production site.

website/content/vagrant-cloud/hcp-vagrant/troubleshooting.mdx Outdated
### Retrying Migrations

If a migration fails, a `retry` icon will appear beside the name of that organization on the [migration status](https://app.beta.vagrantup.com/migration/status) page. Failed migrations can be retried once.
In the event of a second failure, contact us at [support@hashicorp.com](mailto:support@hashicorp.com) with the subject `Vagrant Migration`. Our team will be happy to help you complete your migration or reset your organization state.
Copy link
Member

Choose a reason for hiding this comment

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

Email should be support+vagrantcloud@hashicorp.com

@chrisroberts chrisroberts added the backport/website Backport changes into `stable-website` label May 2, 2024
@tehut tehut merged commit ba4077e into main May 2, 2024
13 checks passed
@tehut tehut deleted the vgh-567 branch May 2, 2024 22:54
chrisroberts pushed a commit that referenced this pull request May 2, 2024
@tehut @chrisroberts
Merge pull request #13385 from hashicorp/vgh-567
c7482a4 
Add HCP-Vagrant docs section with Migration Guide & Troubleshooting pages
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kaitlincart kaitlincart kaitlincart left review comments

@chrisroberts chrisroberts chrisroberts approved these changes

Assignees
No one assigned
Labels
backport/website Backport changes into `stable-website`
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@tehut @chrisroberts @kaitlincart