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

fix: integrations text review #4706

Merged
merged 4 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ export const IntegrationDelete: VFC<IIntegrationDeleteProps> = ({ id }) => {
<>
<StyledTitle>Delete integration</StyledTitle>
<StyledHelpText>
Deleting an integration will delete the entire configuration and
will automatically disable the integration
Deleting an integration instance will delete all its
configuration. It will stop working immediately. Other instances
of the same integration are unaffected.
</StyledHelpText>
<StyledContainer>
<PermissionButton
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,8 @@ export const IntegrationForm: VFC<IntegrationFormProps> = ({
<FormTemplate
title={
<>
{submitText} {name ? capitalizeFirst(`${name} `) : ''}
{submitText}{' '}
{displayName || (name ? capitalizeFirst(name) : '')}{' '}
integration
</>
}
Expand Down Expand Up @@ -368,7 +369,7 @@ export const IntegrationForm: VFC<IntegrationFormProps> = ({
entityName="event"
selectAllEnabled={false}
error={errors.events}
description="Select what events you want your integration to be notified about."
description="Select which events you want your integration to be notified about."
required
/>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,8 @@ export const AvailableIntegrations: VFC<IAvailableIntegrationsProps> = ({
Performance and security
</Typography>
<Typography variant="body2" color="text.secondary">
Connect Unleash to private, scalable and distributed
relays. Additional layer for handling massive number
of requests.
Connect Unleash to private, scalable, and
distributed relays.
</Typography>
</div>
<StyledCardsGrid>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ export const OFFICIAL_SDKS: Sdk[] = [
},
{
name: 'dotnet',
displayName: '.Net SDK',
description: 'Officially Unleash Client for .Net',
displayName: '.NET SDK',
description: 'Officially Unleash Client for .NET',
Tymek marked this conversation as resolved.
Show resolved Hide resolved
documentationUrl: 'https://docs.getunleash.io/reference/sdks/dotnet ',
type: 'server',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export const ConfiguredIntegrations: VFC<ConfiguredIntegrationsProps> = ({
isEnabled={enabled}
description={description || ''}
link={`/integrations/edit/${id}`}
configureActionText="Configure"
/>
);
})}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import useAddons from 'hooks/api/getters/useAddons/useAddons';
import useToast from 'hooks/useToast';
import { formatUnknownError } from 'utils/formatUnknownError';
import { Dialogue } from 'component/common/Dialogue/Dialogue';
import { event } from 'cypress/types/jquery';

interface IIntegrationCardMenuProps {
addon: AddonSchema;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export const RequestIntegrationCard: VFC = () => (
rel="noopener noreferrer"
>
<Typography variant="body2" color="text.secondary" data-loading>
Are we missing any integration that you need?
Are we missing an integration that you need?
</Typography>
<Typography variant="body2" color="text.secondary" data-loading>
Go ahead and request it!
Expand Down
4 changes: 4 additions & 0 deletions frontend/src/themes/dark-theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ const theme = {
fontSize: '1rem',
fontWeight: '700',
},
h4: {
fontSize: '1rem',
fontWeight: '400',
},
caption: {
fontSize: `${12 / 16}rem`,
},
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/themes/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { colors } from './colors';
import { alpha } from '@mui/material';
import { focusable } from 'themes/themeStyles';

const theme = {
export const theme = {
breakpoints: {
values: {
xs: 0,
Expand Down
6 changes: 3 additions & 3 deletions src/lib/addons/datadog-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const dataDogDefinition: IAddonDefinition = {
name: 'url',
displayName: 'Datadog Events URL',
description:
'Default url: https://api.datadoghq.com/api/v1/events. Needs to be changed if your not using the US1 site.',
"Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site.",
type: 'url',
required: false,
sensitive: false,
Expand All @@ -37,7 +37,7 @@ const dataDogDefinition: IAddonDefinition = {
name: 'apiKey',
displayName: 'Datadog API key',
placeholder: 'j96c23b0f12a6b3434a8d710110bd862',
description: '(Required) API key from Datadog',
description: '(Required) API key to connect to Datadog',
type: 'text',
required: true,
sensitive: true,
Expand All @@ -57,7 +57,7 @@ const dataDogDefinition: IAddonDefinition = {
placeholder:
'{\n"ISTIO_USER_KEY": "hunter2",\n"SOME_OTHER_CUSTOM_HTTP_HEADER": "SOMEVALUE"\n}',
description:
'(Optional) Used to add extra HTTP Headers to the request the plugin fires off. Format here needs to be a valid json object of key value pairs where both key and value are strings',
'(Optional) Used to add extra HTTP Headers to the request the plugin fires off. This must be a valid json object of key-value pairs where both the key and the value are strings',
required: false,
sensitive: true,
type: 'textfield',
Expand Down
2 changes: 1 addition & 1 deletion src/lib/addons/slack-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const slackDefinition: IAddonDefinition = {
displayName: 'Extra HTTP Headers',
placeholder:
'{\n"ISTIO_USER_KEY": "hunter2",\n"SOME_OTHER_CUSTOM_HTTP_HEADER": "SOMEVALUE"\n}',
description: `(Optional) Used to add extra HTTP Headers to the request the plugin fires off. Format here needs to be a valid json object of key value pairs where both key and value are strings`,
description: `(Optional) Used to add extra HTTP Headers to the request the plugin fires off. This must be a valid json object of key-value pairs where both the key and the value are strings`,
required: false,
sensitive: true,
type: 'textfield',
Expand Down
4 changes: 2 additions & 2 deletions src/lib/addons/teams-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const teamsDefinition: IAddonDefinition = {
displayName: 'Microsoft Teams',
description: 'Allows Unleash to post updates to Microsoft Teams.',
documentationUrl: 'https://docs.getunleash.io/docs/addons/teams',
howTo: 'The MicrosoftTeams integration allows Unleash to post Updates when a feature toggle is updated.',
howTo: 'The Microsoft Teams integration allows Unleash to post Updates when a feature toggle is updated.',
parameters: [
{
name: 'url',
Expand All @@ -37,7 +37,7 @@ const teamsDefinition: IAddonDefinition = {
displayName: 'Extra HTTP Headers',
placeholder:
'{\n"ISTIO_USER_KEY": "hunter2",\n"SOME_OTHER_CUSTOM_HTTP_HEADER": "SOMEVALUE"\n}',
description: `(Optional) Used to add extra HTTP Headers to the request the plugin fires off. Format here needs to be a valid json object of key value pairs where both key and value are strings`,
description: `(Optional) Used to add extra HTTP Headers to the request the plugin fires off. This must be a valid json object of key-value pairs where both the key and the value are strings`,
required: false,
sensitive: true,
type: 'textfield',
Expand Down
4 changes: 2 additions & 2 deletions src/lib/addons/webhook-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const webhookDefinition: IAddonDefinition = {
description:
'A Webhook is a generic way to post messages from Unleash to third party services.',
documentationUrl: 'https://docs.getunleash.io/docs/addons/webhook',
howTo: 'The Webhook Addon introduces a generic way to post messages from Unleash to third party services. Unleash allows you to define a webhook which listens changes in Unleash and post them to a third party services.',
howTo: 'The Webhook Addon introduces a generic way to post messages from Unleash to third party services. Unleash allows you to define a webhook which listens for changes in Unleash and posts them to a third party services.',
parameters: [
{
name: 'url',
Expand Down Expand Up @@ -85,7 +85,7 @@ const webhookDefinition: IAddonDefinition = {
displayName: 'Extra HTTP Headers',
placeholder:
'{\n"ISTIO_USER_KEY": "hunter2",\n"SOME_OTHER_CUSTOM_HTTP_HEADER": "SOMEVALUE"\n}',
description: `(Optional) Used to add extra HTTP Headers to the request the plugin fires off. Format here needs to be a valid json object of key value pairs where both key and value are strings`,
description: `(Optional) Used to add extra HTTP Headers to the request the plugin fires off. This must be a valid json object of key-value pairs where both the key and the value are strings`,
required: false,
sensitive: true,
type: 'textfield',
Expand Down
5 changes: 3 additions & 2 deletions src/lib/openapi/spec/addons-schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ export const addonsSchema = {
name: 'url',
displayName: 'Datadog Events URL',
description:
'Default url: https://api.datadoghq.com/api/v1/events. Needs to be changed if your not using the US1 site.',
"Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site.",
type: 'url',
required: false,
sensitive: false,
Expand All @@ -226,7 +226,8 @@ export const addonsSchema = {
name: 'apiKey',
displayName: 'Datadog API key',
placeholder: 'j96c23b0f12a6b3434a8d710110bd862',
description: '(Required) API key from Datadog',
description:
'(Required) API key to connect to Datadog',
type: 'text',
required: true,
sensitive: true,
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/addons/teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Microsoft Teams

> This feature was introduced in _Unleash v4.0.0_.
The MicrosoftTeams addon allows Unleash to post Updates when a feature toggle is updated. To set up this addon, you need to set up a webhook connector for your channel. You can follow [Creating an Incoming Webhook for a channel](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) on how to do that.
The Microsoft Teams addon allows Unleash to post Updates when a feature toggle is updated. To set up this addon, you need to set up a webhook connector for your channel. You can follow [Creating an Incoming Webhook for a channel](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) on how to do that.

The Microsoft Teams addon will perform a single retry if the HTTP POST against the Microsoft Teams Webhook URL fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/deploy/configuring-unleash.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ unleash.start(unleashOptions);
- **preHook** (function) - this is a hook if you need to provide any middlewares to express before `unleash` adds any. Express app instance is injected as first argument.
- **preRouterHook** (function) - use this to register custom express middlewares before the `unleash` specific routers are added.
- **secureHeaders** (boolean) - use this to enable security headers (HSTS, CSP, etc) when serving Unleash from HTTPS. Can also be configured through the environment variable `SECURE_HEADERS`.
- **additionalCspAllowedDomains** (CspAllowedDomains) - use this when you want to enable security headers but have additional domains you need to allow traffic to you can set the following environment variables:
- **additionalCspAllowedDomains** (CspAllowedDomains) - use this when you want to enable security headers but have additional domains you need to allow traffic to. You can set the following environment variables:
- `CSP_ALLOWED_DEFAULT` to allow new defaultSrc (comma separated list)
- `CSP_ALLOWED_FONT` to allow new fontSrc (comma separated list)
- `CSP_ALLOWED_STYLE` to allow new styleSrc (comma separated list)
Expand Down