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

docs/nia: reorganize tf module details to top level nav #9830

Merged
merged 2 commits into from
Feb 25, 2021
Merged

docs/nia: reorganize tf module details to top level nav #9830

merged 2 commits into from
Feb 25, 2021

Conversation

findkim
Copy link
Contributor

@findkim findkim commented Feb 25, 2021 •
edited
Loading

  • Moved previous "How to Create a Compatible Terraform Module" from /docs/nia/installation/requirements page to a top level page /docs/nia/terraform-modules here
  • Added more information on how to start building a module here
  • Renamed "Using Terraform Modules" to "Partner Terraform Modules" here
  • Removed last bits of "Tech Preview" to "Beta" that I could find

@findkim findkim added type/docs Documentation needs to be created/updated/clarified theme/consul-terraform-sync Relating to Consul Terraform Sync and Network Infrastructure Automation labels Feb 25, 2021
@findkim findkim requested a review from a team February 25, 2021 06:52
lornasong
lornasong reviewed Feb 25, 2021
View reviewed changes
Copy link
Member

@lornasong lornasong left a comment

Choose a reason for hiding this comment

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

New module page ✨ . I tested all the links and they look good! I left a couple suggestions of places for clarifications that I came across while trying to read as though I were a new user.

website/content/docs/nia/index.mdx
# Network Infrastructure Automation <sup>Tech Preview</sup>
# Network Infrastructure Automation <sup>Beta</sup>
Copy link
Member

Choose a reason for hiding this comment

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

nice catch with these 'Tech Preview's!

website/content/docs/nia/installation/requirements.mdx Outdated Show resolved Hide resolved
website/content/docs/nia/terraform-modules.mdx
@@ -0,0 +1,123 @@
---
layout: docs
page_title: Compatible Terraform Modules for NIA
Copy link
Member

Choose a reason for hiding this comment

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

I like having a modules-specific page! I think it will make it easier for users to have all the module info in a single place

website/content/docs/nia/terraform-modules.mdx Outdated Show resolved Hide resolved
website/content/docs/nia/terraform-modules.mdx Outdated Show resolved Hide resolved
website/content/docs/nia/terraform-modules.mdx Outdated Show resolved Hide resolved
website/content/docs/nia/terraform-modules.mdx Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview – consul-ui-staging February 25, 2021 18:27 Inactive
@findkim findkim requested a review from lornasong February 25, 2021 18:31
eikenb
eikenb approved these changes Feb 25, 2021
View reviewed changes
Copy link
Contributor

@eikenb eikenb left a comment

Choose a reason for hiding this comment

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

Read through the changes and it sounded good to me.

My one comment is probably more meta than something actionable in this PR... just something I've seen mentioned but don't remember ever hearing "how".

lornasong
lornasong approved these changes Feb 25, 2021
View reviewed changes
Copy link
Member

@lornasong lornasong left a comment

Choose a reason for hiding this comment

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

Approving for the stuff we chatted on! Appreciate the clarifications :). I like the reorganization of the how-to-create-a-module section.

@findkim findkim merged commit 6ca6f14 into nia/docs-0.1.0-beta Feb 25, 2021
@findkim findkim deleted the cts-tf-modules branch February 25, 2021 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eikenb eikenb eikenb approved these changes

@lornasong lornasong lornasong approved these changes

Assignees
No one assigned
Labels
theme/consul-terraform-sync Relating to Consul Terraform Sync and Network Infrastructure Automation type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@findkim @eikenb @lornasong