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

Misc doc updates #119

Merged
merged 6 commits into from
May 10, 2021
Merged

Misc doc updates #119

merged 6 commits into from
May 10, 2021

Conversation

bcmdarroch
Copy link
Contributor

@bcmdarroch bcmdarroch commented May 8, 2021

🛠️ Description

This PR takes care of a few doc updates in advance of Monday's release:

  • merges quick-start page's context with the overview page and deletes quick-start (we want the overview page to be the most beginner friendly page of our docs)
  • adds some information about release stage to the PR template
  • adds a beta banner to consul cluster doc to indicate federation is in private beta

@bcmdarroch bcmdarroch requested a review from a team May 8, 2021 00:02
@bcmdarroch bcmdarroch self-assigned this May 8, 2021
Comment on lines 4 to 5
Hashicorp contributors, please consider: what stage of release is your feature in?
If the feature is for internal Hashicorp usage only, it should be maintained on a feature branch until ready for beta release.
Copy link
Contributor

Choose a reason for hiding this comment

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

🙌

Super nit: I think HashiCorp is preferred over Hashicorp, so might be good to be consistent even in this messaging

@@ -20,6 +20,17 @@ The HCP provider supports authentication via a Client ID and a Client Secret. Th

## Example Usage

Everything in HashiCorp Cloud Platform (HCP) starts with the HashiCorp Virtual Network (HVN).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we change the heading from Example Usage to something else like Getting Started? When I read this section within the context of the Example Usage heading, some of the explanation and instruction seemed slightly out of place.

Copy link
Contributor

@riddhi89 riddhi89 left a comment

Choose a reason for hiding this comment

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

Thanks for adding the beta banner for federation 👍

@bcmdarroch bcmdarroch merged commit 83d2ad0 into main May 10, 2021
@bcmdarroch bcmdarroch deleted the misc-doc-updates branch May 10, 2021 21:43
aidan-mundy added a commit that referenced this pull request Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants