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

maintain: clean up architecture...and the rest #3413

Merged
merged 5 commits into from
Oct 11, 2022
Merged

Conversation

technovangelist
Copy link
Contributor

Signed-off-by: Matt Williams m@technovangelist.com

Summary

The architecture page had issues, so fixed them up. And then looked at active vs passive voice, better grammar throughout, and so much more.

Checklist

  • Wrote appropriate unit tests
  • Considered security implications of the change
  • Updated associated docs where necessary
  • Updated associated configuration where necessary
  • Change is backwards compatible if it needs to be (user can upgrade without manual steps?)
  • Nothing sensitive logged
  • Considered data migrations for smooth upgrades

Related Issues

Resolves #

Signed-off-by: Matt Williams <m@technovangelist.com>
@@ -42,17 +42,48 @@ helm upgrade --install infra-connector infrahq/infra \

{% callout type="info" %}

Note: it may take a few minutes for the LoadBalancer to be provisioned.
Note: it may take a few minutes for the Load Balancer to be provisioned.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This shouldn't be changed since it's the Kubernetes resource name

@@ -2,812 +2,835 @@
title: CLI Reference
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is generated so it shouldn't be manually changed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, how is it generated? I can update that instead

Copy link
Collaborator

@mxyng mxyng Oct 7, 2022

Choose a reason for hiding this comment

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

It's generated by internal/docgen. You can generate docs with go run ./internal/docgen/

Copy link
Contributor

@mchiang0610 mchiang0610 left a comment

Choose a reason for hiding this comment

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

saw @mxyng's comment above per CLI docs need to be generated. Let's get that in. Otherwise this is a step forward, and we can make more iterations as we go.

@vercel vercel bot temporarily deployed to Preview October 11, 2022 15:14 Inactive
@vercel vercel bot temporarily deployed to Preview October 11, 2022 16:50 Inactive
Signed-off-by: Matt Williams <m@technovangelist.com>
@vercel vercel bot temporarily deployed to Preview October 11, 2022 17:39 Inactive
Signed-off-by: Matt Williams <m@technovangelist.com>
@technovangelist technovangelist merged commit ee5dac0 into main Oct 11, 2022
@technovangelist technovangelist deleted the matt/clean-arch branch October 11, 2022 17:40
@vercel vercel bot temporarily deployed to Preview October 11, 2022 17:40 Inactive
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