From d2048d47a92130aad272299b654c5677433387a3 Mon Sep 17 00:00:00 2001 From: Klink <85062+dogmar@users.noreply.github.com> Date: Mon, 13 Nov 2023 16:05:46 -0800 Subject: [PATCH] fix: Expired discord link --- cli-readme/README.md | 24 +++++++++---------- pages/applications/dagster.mdpart | 2 +- .../getting-started/cloud-shell-quickstart.md | 4 ++-- pages/index.tsx | 3 ++- pages/introduction.md | 2 +- pages/reference/troubleshooting.md | 2 +- src/components/MobileMenu.tsx | 4 +++- src/components/PageHeader.tsx | 4 +++- src/consts.ts | 1 + src/generated/pages.json | 2 +- 10 files changed, 26 insertions(+), 22 deletions(-) diff --git a/cli-readme/README.md b/cli-readme/README.md index 0c8c59e3..c6ff3b3f 100644 --- a/cli-readme/README.md +++ b/cli-readme/README.md @@ -1,13 +1,12 @@ # Welcome to Your Plural Repo -This is the repo that will house all your Plural installations for this cluster. We'll give you a quick walkthrough how everything works here. In general, there are two commands you'll run in your Plural workflow: +This is the repo that will house all your Plural installations for this cluster. We'll give you a quick walkthrough how everything works here. In general, there are two commands you'll run in your Plural workflow: ``` plural build // generates infrastructure as code for your installations plural deploy // deploys your IAC resources in dependency-order ``` - If you want to install a new app, you can run: ``` @@ -21,7 +20,7 @@ If you want an at-a-glance view of the health of any application, you can run: plural watch APP_NAME ``` -but the best way to manage and monitor your applications is with the Plural Console, which you can install with `plural bundle install console console-{aws,gcp,azure,etc}`. We strongly recommend doing this. +but the best way to manage and monitor your applications is with the Plural Console, which you can install with `plural bundle install console console-{aws,gcp,azure,etc}`. We strongly recommend doing this. ## Workspace Structure @@ -42,33 +41,32 @@ We generate infrastructure as code resources in a consistent format: - main.tf # can override submodule configuration here, see that file for more info ``` -In general we expect you to customize the repo as you wish, and any standard Terraform or Helm command should work as expected. Let's say you wanted to switch the database for an app to RDS. To do this, you can use the app's dedicated Terraform folder in the repo to define the database and inject its secret into Kubernetes right there. +In general we expect you to customize the repo as you wish, and any standard Terraform or Helm command should work as expected. Let's say you wanted to switch the database for an app to RDS. To do this, you can use the app's dedicated Terraform folder in the repo to define the database and inject its secret into Kubernetes right there. There are two other metadata files you should be aware of as well: -* `context.yaml` - this is the initial app configuration you provide when running `plural bundle install`. We use this to generate the resources that are present in your app folder above. You can reconfigure settings here if you'd like, or occasionally enable different configurations. Airbyte basic auth requires a `context.yaml` change for instance. +- `context.yaml` - this is the initial app configuration you provide when running `plural bundle install`. We use this to generate the resources that are present in your app folder above. You can reconfigure settings here if you'd like, or occasionally enable different configurations. Airbyte basic auth requires a `context.yaml` change for instance. -* `workspace.yaml` - this is the high level workspace metadata about your workspace, like the cloud account, cluster name, dns domain, etc. For the most part, this file should remain read-only. +- `workspace.yaml` - this is the high level workspace metadata about your workspace, like the cloud account, cluster name, dns domain, etc. For the most part, this file should remain read-only. ## Secret Management -We automatically encrypt this repo using a go reimplementation of [git-crypt](https://github.com/AGWA/git-crypt). You'll be able to see the AES key you're currently using with `plural crypto export`. We also drop the key fingerprint into the repo at `.keyid` to validate and provide appropriate error messages. +We automatically encrypt this repo using a go reimplementation of [git-crypt](https://github.com/AGWA/git-crypt). You'll be able to see the AES key you're currently using with `plural crypto export`. We also drop the key fingerprint into the repo at `.keyid` to validate and provide appropriate error messages. -It's strongly recommended you backup this key, and we provide a backup API for you with `plural crypto backups create`. You can sync any backup with `plural crypto backups resource NAME`. You can also use popular solutions for this like 1password, Vault or your cloud's secrets manager. +It's strongly recommended you backup this key, and we provide a backup API for you with `plural crypto backups create`. You can sync any backup with `plural crypto backups resource NAME`. You can also use popular solutions for this like 1password, Vault or your cloud's secrets manager. -If you reclone this repo on a new machine, its contents will be fully encrypted. In that case you'll need to set up the encryption credentials for the repo, then run: +If you reclone this repo on a new machine, its contents will be fully encrypted. In that case you'll need to set up the encryption credentials for the repo, then run: ``` plural crypto init plural crypto unlock ``` - ## Destroying Your Cluster -You can tear down the cluster at any time using `plural destroy`. If it gets jammed on a specific app, you can simply rerun with `plural destroy --from APP_NAME`. +You can tear down the cluster at any time using `plural destroy`. If it gets jammed on a specific app, you can simply rerun with `plural destroy --from APP_NAME`. -In break glass scenarios where destroy doesn't want to behave, the bulk of the cloud resources are in the bootstrap app, and you can simply run `cd bootstrap && terraform destroy` manually. If you encounter this feel free to let us know so we can improve our packaging. +In break glass scenarios where destroy doesn't want to behave, the bulk of the cloud resources are in the bootstrap app, and you can simply run `cd bootstrap && terraform destroy` manually. If you encounter this feel free to let us know so we can improve our packaging. ## Support -If you have any issues with plural or any of the apps in the catalog, we pride ourselves on providing prompt support. You can join our Discord at [https://discord.gg/pluralsh](https://discord.gg/pluralsh) and we'll try to troubleshoot the issue for you. You can find common troubleshooting tips [here](https://docs.plural.sh/reference/troubleshooting) as well. \ No newline at end of file +If you have any issues with plural or any of the apps in the catalog, we pride ourselves on providing prompt support. You can join our Discord [here](https://discord.com/invite/bEBAMXV64s), and we'll try to troubleshoot the issue for you. You can find common troubleshooting tips [here](https://docs.plural.sh/reference/troubleshooting) as well. diff --git a/pages/applications/dagster.mdpart b/pages/applications/dagster.mdpart index e60cb41f..a22a036b 100644 --- a/pages/applications/dagster.mdpart +++ b/pages/applications/dagster.mdpart @@ -81,6 +81,6 @@ Only do this if you're absolutely sure you want to bring down all associated res ## Troubleshooting -If you run into any issues with installing Dagster on Plural, feel free to join our [Discord Community](https://discord.gg/pluralsh) so that we can help you out. +If you run into any issues with installing Dagster on Plural, feel free to join our [Discord Community](https://discord.com/invite/bEBAMXV64s) so that we can help you out. If you'd like to request any updates or new features for our Dagster installation, feel free to open an issue [here](https://github.com/pluralsh/plural-artifacts). diff --git a/pages/getting-started/cloud-shell-quickstart.md b/pages/getting-started/cloud-shell-quickstart.md index 179787de..33fad243 100644 --- a/pages/getting-started/cloud-shell-quickstart.md +++ b/pages/getting-started/cloud-shell-quickstart.md @@ -191,7 +191,7 @@ When your applications are finished installing, you'll be able to see the domain Occasionally errors can crop up during the build and deploy process. If your build or deploy fails, you can try re-running the commands to see if it resolves an intermittent issue. To do this, click into the terminal window and either tap the up arrow key to see the last command or type in `plural build && plural deploy --commit "deploying a few apps with plural"` to relaunch the process from where it left off and commit your changes when finished. -If errors persist, check out our [Troubleshooting documentation](/debugging/common-errors) or [reach out to us on our community Discord](https://discord.gg/pluralsh) for help. +If errors persist, check out our [Troubleshooting documentation](/debugging/common-errors) or [reach out to us on our community Discord](https://discord.com/invite/bEBAMXV64s) for help. ## Check out your Deployments @@ -253,4 +253,4 @@ plural shell purge ### Feedback -If you have any feedback or questions about the experience, [head over to our community Discord](https://discord.gg/pluralsh) and drop us some feedback. The Cloud Shell is still in development and we are dedicated to perfecting the user experience, so any feedback would be immensely helpful to us. +If you have any feedback or questions about the experience, [head over to our community Discord](https://discord.com/invite/bEBAMXV64s) and drop us some feedback. The Cloud Shell is still in development and we are dedicated to perfecting the user experience, so any feedback would be immensely helpful to us. diff --git a/pages/index.tsx b/pages/index.tsx index b77814ec..d9c8e1fa 100644 --- a/pages/index.tsx +++ b/pages/index.tsx @@ -23,6 +23,7 @@ import { Heading as MarkdocHeading } from '@pluralsh/design-system/dist/markdoc/ import styled, { useTheme } from 'styled-components' import { mqs } from '@src/components/Breakpoints' +import { DISCORD_LINK } from '@src/consts' const Hero = styled.div(({ theme }) => ({ background: 'url(/images/landing/hero-bg-sm.png)', @@ -256,7 +257,7 @@ function Index() { } - href="https://discord.gg/pluralsh" + href={DISCORD_LINK} target="_blank" rel="nofollow noreferrer" > diff --git a/pages/introduction.md b/pages/introduction.md index 9682c979..eebc4dfe 100644 --- a/pages/introduction.md +++ b/pages/introduction.md @@ -43,7 +43,7 @@ We have created a Cloud Shell with all of the tools and dependencies needed to r - [Using our in-browser Cloud Shell](/getting-started/cloud-shell-quickstart) -If you need support getting your Plural deployment up and running, join the [Plural Discord here!](https://discord.gg/pluralsh) +If you need support getting your Plural deployment up and running, join the [Plural Discord here!](https://discord.com/invite/bEBAMXV64s) ## Architecture diff --git a/pages/reference/troubleshooting.md b/pages/reference/troubleshooting.md index 85cea7be..be684e40 100644 --- a/pages/reference/troubleshooting.md +++ b/pages/reference/troubleshooting.md @@ -160,4 +160,4 @@ cd application-name/terraform terraform import path_to_terraform_resource resource_id ``` -If you devise a better way to recover crashed terraform state, please give us a shout in our [Discord](https://discord.gg/pluralsh). We'd love to automate this better. +If you devise a better way to recover crashed terraform state, please give us a shout in our [Discord](https://discord.com/invite/bEBAMXV64s). We'd love to automate this better. diff --git a/src/components/MobileMenu.tsx b/src/components/MobileMenu.tsx index cbaaace9..d6430957 100644 --- a/src/components/MobileMenu.tsx +++ b/src/components/MobileMenu.tsx @@ -3,6 +3,8 @@ import { DiscordIcon } from '@pluralsh/design-system' import styled from 'styled-components' import { useIsomorphicLayoutEffect } from 'usehooks-ts' +import { DISCORD_LINK } from '@src/consts' + import { FullNav } from './FullNav' import GithubStars from './GithubStars' import useScrollLock from './hooks/useScrollLock' @@ -38,7 +40,7 @@ function PluralMenuContent({ Sign in { return `How to easily install and manage ${displayName} on Kubernetes using Plural.` } +export const DISCORD_LINK = 'https://discord.com/invite/bEBAMXV64s' diff --git a/src/generated/pages.json b/src/generated/pages.json index d0fcb5b6..b6a21dda 100644 --- a/src/generated/pages.json +++ b/src/generated/pages.json @@ -93,7 +93,7 @@ "path": "/deployments/browser-quickstart" }, { - "path": "/deployments/ci-example" + "path": "/deployments/ci-gh-actions" }, { "path": "/deployments/ci-overview"