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: update documentation #3233

Merged
merged 10 commits into from
Sep 19, 2022
Merged

maintain: update documentation #3233

merged 10 commits into from
Sep 19, 2022

Conversation

technovangelist
Copy link
Contributor

Summary

Update the documentation to be SaaS-first, dashboard-first.

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: Matthew Williams <m@technovangelist.com>
Signed-off-by: Matthew Williams <m@technovangelist.com>
Signed-off-by: Matthew Williams <m@technovangelist.com>
Signed-off-by: Matt Williams <m@technovangelist.com>
docs/start/quickstart.md Outdated Show resolved Hide resolved
docs/start/quickstart.md Outdated Show resolved Hide resolved
docs/start/quickstart.md Outdated Show resolved Hide resolved
docs/using/as-a-user.md Outdated Show resolved Hide resolved
docs/manage/connectors/kubernetes.md Outdated Show resolved Hide resolved
Signed-off-by: Matt Williams <m@technovangelist.com>
@vercel vercel bot temporarily deployed to Preview September 19, 2022 17:50 Inactive
Signed-off-by: Matt Williams <m@technovangelist.com>
@vercel vercel bot temporarily deployed to Preview September 19, 2022 18:34 Inactive
@vercel vercel bot temporarily deployed to Preview September 19, 2022 18:47 Inactive
Signed-off-by: Matt Williams <m@technovangelist.com>
@vercel vercel bot temporarily deployed to Preview September 19, 2022 18:54 Inactive
@vercel vercel bot temporarily deployed to Preview September 19, 2022 19:15 Inactive
Signed-off-by: Matt Williams <m@technovangelist.com>
@vercel vercel bot temporarily deployed to Preview September 19, 2022 19:37 Inactive
@technovangelist technovangelist merged commit f4dc124 into main Sep 19, 2022
@technovangelist technovangelist deleted the matt/newdocs branch September 19, 2022 19:38
@@ -38,8 +40,10 @@ body,
@apply prose-pre:py-4;
@apply prose-pre:min-w-full;
@apply prose-pre:font-medium;
@apply prose-img:rounded-lg;
@apply prose-img:bg-gray-700/5;
/* @apply prose-img:rounded-lg; */
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove comments.

/* @apply prose-img:rounded-lg; */
/* @apply prose-img:bg-gray-700/5; */
/* @apply prose-img:border-2;
@apply prose-img:drop-shadow-lg; */
Copy link
Contributor

Choose a reason for hiding this comment

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

This may not be visible due to overflow – we could try:

@apply prose-img:overflow-visible;

@@ -8,7 +8,9 @@ body,
@apply h-full;
@apply antialiased;
}

.prose-docs > img {
Copy link
Contributor

Choose a reason for hiding this comment

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

This would be better as a tailwind rule as below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i forgot i added that.... trying to get anything to work

permanent: true,
},

...[
Copy link
Contributor

Choose a reason for hiding this comment

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

Great idea with the spread operator here


{% callout type="info" %}

We are slowly rolling out our SaaS product. If you are interested in onboarding before we open it up completely, let us know. Until then you can [install the self-hosted version of the Infra Server](../reference/selfhosted.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Great callout! Let's link this to a signup form once that's ready vs sending to self-hosted

Copy link
Contributor Author

Choose a reason for hiding this comment

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

send me the signup form and it will be done

---
# Quickstart

Infra is rolling out it's Software as a Service offering which makes it easier than ever to setup infrastructure access for your organization. This page will show you everything you need to do to get started.
Copy link
Contributor

Choose a reason for hiding this comment

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

These two paragraphs are a ton of frontmatter that may not help the user get started. Let's help them get started!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

refactored

Copy link
Contributor Author

Choose a reason for hiding this comment

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

take a look at #3270

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