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

docs: notification templates #263

Merged
merged 13 commits into from
Sep 3, 2024
Merged

docs: notification templates #263

merged 13 commits into from
Sep 3, 2024

Conversation

adityathebe
Copy link
Member

@adityathebe adityathebe commented Aug 30, 2024

  • created React Components for each notification templates variable
    • This var is then imported in a new notification reference page
    • and then on each event page
  • Added a new withTemplates prop to the Fields component which create a table with a fourth "templates row"
<Fields withTemplates="true" rows={[
  ...
  {
    field: "title",
    description: "Channel dependent e.g. subject for email",
    scheme: "GoTemplate",
    templateEnv: [
      {"name": "CheckHealthEnv", "url": "/reference/notifications/template_vars#check-health-env"},
      {"name": "ConfigHealthEnv", "url": "/reference/notifications/template_vars#config-health-env"},
      {"name": "ConfigStateUpdateEnv", "url": "/reference/notifications/template_vars#config-state-env"},
      {"name": "ComponentHealthEnv", "url": "/reference/notifications/template_vars#component-health-env"},
    ],
  },
  }

]}/>

image

  • Pulled in slack templates from submodules

Copy link

netlify bot commented Aug 30, 2024

Deploy Preview for flanksource-docs ready!

Name Link
🔨 Latest commit 3112bb4
🔍 Latest deploy log https://app.netlify.com/sites/flanksource-docs/deploys/66d6c40489341f000826a08e
😎 Deploy Preview https://deploy-preview-263--flanksource-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Aug 30, 2024

Deploy Preview for canarychecker failed.

Name Link
🔨 Latest commit 3112bb4
🔍 Latest deploy log https://app.netlify.com/sites/canarychecker/deploys/66d6c40485845c0008139349

@adityathebe adityathebe marked this pull request as ready for review August 30, 2024 14:21
@adityathebe adityathebe force-pushed the docs/notification-templates branch 2 times, most recently from 7ec56d4 to 7bee82a Compare August 30, 2024 14:40
@moshloop moshloop merged commit 1fddf7f into main Sep 3, 2024
8 checks passed
@moshloop moshloop deleted the docs/notification-templates branch September 3, 2024 09:14
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.

2 participants