From c53a774675b16ebf788656260d9dfb193c113405 Mon Sep 17 00:00:00 2001 From: Matej Kubinec Date: Wed, 2 Aug 2023 10:23:28 +0200 Subject: [PATCH 1/4] PMM-12310 Update docs links to use a shortener --- .../dashboards/mysql/overview.json | 2 +- .../dashboards/mysql/overview.json | 2 +- public/app/core/components/Footer/Footer.tsx | 6 ++-- .../components/ShareModal/ShareLink.tsx | 7 +---- .../DiscoveryDocs/DiscoveryDocs.constants.ts | 6 ++-- .../AddBackupPage/AddBackupPage.messages.ts | 6 ++-- .../percona/rbac/AccessRoles/AccessRoles.tsx | 2 +- .../app/percona/settings/Settings.messages.ts | 29 +++++++++---------- .../ModalBody/ModalBody.constants.ts | 3 +- .../PerconaBootstrapper.tsx | 2 +- public/app/percona/shared/helpers/api.ts | 6 ++-- .../tour/steps/product/product.steps.tsx | 18 ++---------- 12 files changed, 33 insertions(+), 56 deletions(-) diff --git a/devenv/docker/ha-test-unified-alerting/grafana/provisioning/dashboards/mysql/overview.json b/devenv/docker/ha-test-unified-alerting/grafana/provisioning/dashboards/mysql/overview.json index d072e4c1d281d..149c9a70f413f 100644 --- a/devenv/docker/ha-test-unified-alerting/grafana/provisioning/dashboards/mysql/overview.json +++ b/devenv/docker/ha-test-unified-alerting/grafana/provisioning/dashboards/mysql/overview.json @@ -2437,7 +2437,7 @@ { "title": "Detailed descriptions about metrics", "type": "absolute", - "url": "https://www.percona.com/doc/percona-monitoring-and-management/dashboard.mysql-overview.html#mysql-internal-memory-overview" + "url": "https://per.co.na/mysql_internal_memory_overview" } ], "nullPointMode": "null", diff --git a/devenv/docker/ha_test/grafana/provisioning/dashboards/mysql/overview.json b/devenv/docker/ha_test/grafana/provisioning/dashboards/mysql/overview.json index d072e4c1d281d..149c9a70f413f 100644 --- a/devenv/docker/ha_test/grafana/provisioning/dashboards/mysql/overview.json +++ b/devenv/docker/ha_test/grafana/provisioning/dashboards/mysql/overview.json @@ -2437,7 +2437,7 @@ { "title": "Detailed descriptions about metrics", "type": "absolute", - "url": "https://www.percona.com/doc/percona-monitoring-and-management/dashboard.mysql-overview.html#mysql-internal-memory-overview" + "url": "https://per.co.na/mysql_internal_memory_overview" } ], "nullPointMode": "null", diff --git a/public/app/core/components/Footer/Footer.tsx b/public/app/core/components/Footer/Footer.tsx index cf4f54e2752e1..72d2e0b0ebc6b 100644 --- a/public/app/core/components/Footer/Footer.tsx +++ b/public/app/core/components/Footer/Footer.tsx @@ -25,7 +25,7 @@ export let getFooterLinks = (): FooterLink[] => { id: 'pmm-docs', text: 'Documentation', icon: 'document-info', - url: 'https://www.percona.com/doc/percona-monitoring-and-management/2.x/index.html?utm_source=pmm_footer', + url: 'hhttps://per.co.na/pmm_documentation', target: '_blank', }, { @@ -33,14 +33,14 @@ export let getFooterLinks = (): FooterLink[] => { id: 'support', text: 'Support', icon: 'question-circle', - url: 'https://www.percona.com/services/support?utm_source=pmm_footer', + url: 'https://per.co.na/pmm_support', }, { target: '_blank', id: 'community', text: 'Community', icon: 'comments-alt', - url: 'https://forums.percona.com/c/percona-monitoring-and-management-pmm/percona-monitoring-and-management-pmm-v2?utm_source=pmm_footer', + url: 'https://per.co.na/pmm_community', }, ]; }; diff --git a/public/app/features/dashboard/components/ShareModal/ShareLink.tsx b/public/app/features/dashboard/components/ShareModal/ShareLink.tsx index 5298c62c72d40..ce745dfaf124d 100644 --- a/public/app/features/dashboard/components/ShareModal/ShareLink.tsx +++ b/public/app/features/dashboard/components/ShareModal/ShareLink.tsx @@ -187,12 +187,7 @@ export class ShareLink extends PureComponent { {/* @PERCONA */} {/* We modified this text and link */} To render a panel image, you must install the  - + Image Renderer plugin . Please contact your PMM administrator to install the plugin. diff --git a/public/app/percona/add-instance/components/Discovery/components/DiscoveryDocs/DiscoveryDocs.constants.ts b/public/app/percona/add-instance/components/Discovery/components/DiscoveryDocs/DiscoveryDocs.constants.ts index 56931723f88b9..bcab8eaa039e2 100644 --- a/public/app/percona/add-instance/components/Discovery/components/DiscoveryDocs/DiscoveryDocs.constants.ts +++ b/public/app/percona/add-instance/components/Discovery/components/DiscoveryDocs/DiscoveryDocs.constants.ts @@ -1,4 +1,2 @@ -export const SECURITY_CREDENTIALS_DOC_LINK = - 'https://www.percona.com/doc/percona-monitoring-and-management/2.x/setting-up/client/aws.html#creating-an-iam-user-with-permission-to-access-amazon-rds-db-instances'; -export const IAM_ROLE_DOC_LINK = - 'https://www.percona.com/doc/percona-monitoring-and-management/2.x/setting-up/client/aws.html#creating-an-iam-role'; +export const SECURITY_CREDENTIALS_DOC_LINK = 'https://per.co.na/iam_user_with_permission'; +export const IAM_ROLE_DOC_LINK = 'https://per.co.na/iam_role'; diff --git a/public/app/percona/backup/components/AddBackupPage/AddBackupPage.messages.ts b/public/app/percona/backup/components/AddBackupPage/AddBackupPage.messages.ts index f829733e2a3ee..9dfb45e2e45b1 100644 --- a/public/app/percona/backup/components/AddBackupPage/AddBackupPage.messages.ts +++ b/public/app/percona/backup/components/AddBackupPage/AddBackupPage.messages.ts @@ -48,13 +48,13 @@ export const Messages = { folderTooltip: 'Changing the default folder, if available, is not recommended', folderTooltipLink: (vendor: Databases | null, mode: BackupMode) => { if (vendor === Databases.mysql) { - return 'https://docs.percona.com/percona-monitoring-and-management/get-started/backup/create_mysql_backup.html#folder-field'; + return 'https://per.co.na/mysql_folder_field'; } if (vendor === Databases.mongodb) { return mode === BackupMode.PITR - ? 'https://docs.percona.com/percona-monitoring-and-management/get-started/backup/create_PITR_mongo.html#folder-field' - : 'https://docs.percona.com/percona-monitoring-and-management/get-started/backup/create_mongo_on_demand.html#folder-field'; + ? 'https://per.co.na/mongo_pitr_folder_field' + : 'https://per.co.na/mongo_folder_field'; } return; diff --git a/public/app/percona/rbac/AccessRoles/AccessRoles.tsx b/public/app/percona/rbac/AccessRoles/AccessRoles.tsx index 82e52ed22b239..8eda0c622e8bd 100644 --- a/public/app/percona/rbac/AccessRoles/AccessRoles.tsx +++ b/public/app/percona/rbac/AccessRoles/AccessRoles.tsx @@ -47,7 +47,7 @@ const AccessRolesPage: FC = () => { className={styles.link} target="_blank" rel="noreferrer noopener" - href="https://docs.percona.com/percona-monitoring-and-management/get-started/roles-and-permissions/index.html" + href="https://per.co.na/roles_permissions" > {Messages.subtitle.link} diff --git a/public/app/percona/settings/Settings.messages.ts b/public/app/percona/settings/Settings.messages.ts index 6e647ec1795ab..1f08cfd61c854 100644 --- a/public/app/percona/settings/Settings.messages.ts +++ b/public/app/percona/settings/Settings.messages.ts @@ -1,20 +1,18 @@ -export const HOW_TO_DOC_URL = 'https://www.percona.com/doc/percona-monitoring-and-management/2.x/how-to/configure.html'; - export const Messages = { advanced: { action: 'Apply changes', retentionLabel: 'Data retention', retentionTooltip: 'This is the value for how long data will be stored.', retentionUnits: 'days', - retentionLink: `${HOW_TO_DOC_URL}#data-retention`, + retentionLink: `https://per.co.na/data_retention`, telemetryLabel: 'Telemetry', - telemetryLink: `${HOW_TO_DOC_URL}#telemetry`, + telemetryLink: `https://per.co.na/telemetry`, telemetryTooltip: 'Option to send usage data back to Percona to let us make our product better.', telemetryDisclaimer: 'Disabling Telemetry while Advisors/Percona Alerting is on will prevent PMM from downloading checks and alert templates.', telemetrySummaryTitle: 'We gather and send the following information to Percona:', updatesLabel: 'Check for updates', - updatesLink: `${HOW_TO_DOC_URL}#check-for-updates`, + updatesLink: `https://per.co.na/updates`, updatesTooltip: 'Option to check new versions and ability to update PMM from UI.', advisorsLabel: 'Advisors', sttRareIntervalLabel: 'Rare interval', @@ -23,28 +21,27 @@ export const Messages = { sttCheckIntervalsLabel: 'Execution Intervals', sttCheckIntervalTooltip: 'Interval between check runs', sttCheckIntervalUnit: 'hours', - advisorsLink: `${HOW_TO_DOC_URL}#advisors`, + advisorsLink: `https://per.co.na/advisors`, advisorsTooltip: 'Enable Advisors and get updated checks from Percona.', dbaasLabel: 'Database as a Service (DBaaS)', azureDiscoverLabel: 'Microsoft Azure monitoring', azureDiscoverTooltip: 'Option to enable/disable Microsoft Azure DB instanced discovery and monitoring', - azureDiscoverLink: `${HOW_TO_DOC_URL}#microsoft-azure-monitoring`, + azureDiscoverLink: `https://per.co.na/azure_monitoring`, dbaasTooltip: 'Option to enable/disable DBaaS features. Disabling DBaaS does not suspend or remove running clusters.', - dbaasLink: `${HOW_TO_DOC_URL}#dbaas`, + dbaasLink: `https://per.co.na/dbaas`, accessControl: 'Access control', accessControlTooltip: 'Option to enable/disable Access control.', - accessControlLink: - 'https://docs.percona.com/percona-monitoring-and-management/get-started/roles-and-permissions/index.html', + accessControlLink: 'https://per.co.na/roles_permissions', publicAddressLabel: 'Public Address', publicAddressTooltip: 'Public Address to this PMM server.', publicAddressButton: 'Get from browser', alertingLabel: 'Percona Alerting', alertingTooltip: 'Option to enable/disable Percona Alerting features.', - alertingLink: `${HOW_TO_DOC_URL}#alerting`, + alertingLink: `https://per.co.na/alerting`, backupLabel: 'Backup Management', backupTooltip: 'Option to enable/disable Backup Management features.', - backupLink: `${HOW_TO_DOC_URL}#backup-management`, + backupLink: `https://per.co.na/backup_management`, technicalPreviewLegend: 'Technical preview features', technicalPreviewDescription: 'These are technical preview features, not recommended to be used in production environments. Read more\n' + @@ -57,10 +54,10 @@ export const Messages = { warningPost: 'but you need to manage and configure alerts.', action: 'Apply Alertmanager settings', rulesLabel: 'Prometheus Alerting rules', - rulesLink: `${HOW_TO_DOC_URL}#prometheus-alertmanager-integration`, + rulesLink: `https://per.co.na/alertmanager`, rulesTooltip: 'Alerting rules in the YAML configuration format.', urlLabel: 'Alertmanager URL', - urlLink: `${HOW_TO_DOC_URL}#prometheus-alertmanager-integration`, + urlLink: `https://per.co.na/alertmanager`, urlTooltip: 'The URL of the external Alertmanager to use.', }, diagnostics: { @@ -72,7 +69,7 @@ export const Messages = { metrics: { action: 'Apply changes', label: 'Metrics resolution, sec', - link: `${HOW_TO_DOC_URL}#server-admin-gui-metrics-resolution`, + link: `https://per.co.na/metrics_resolution`, options: { rare: 'Rare', standard: 'Standard', @@ -89,7 +86,7 @@ export const Messages = { ssh: { action: 'Apply SSH key', label: 'SSH key', - link: `${HOW_TO_DOC_URL}#ssh-key-details`, + link: `https://per.co.na/ssh_key`, tooltip: 'Public SSH key to let you login into the server using SSH.', }, service: { diff --git a/public/app/percona/settings/components/Platform/Connected/ModalBody/ModalBody.constants.ts b/public/app/percona/settings/components/Platform/Connected/ModalBody/ModalBody.constants.ts index 2727651f35a62..29d1dd9517558 100644 --- a/public/app/percona/settings/components/Platform/Connected/ModalBody/ModalBody.constants.ts +++ b/public/app/percona/settings/components/Platform/Connected/ModalBody/ModalBody.constants.ts @@ -1,2 +1 @@ -export const URL_DOC = - 'https://docs.percona.com/percona-monitoring-and-management/how-to/integrate-platform.html#disconnect-a-pmm-instance'; +export const URL_DOC = 'https://per.co.na/disconnect'; diff --git a/public/app/percona/shared/components/PerconaBootstrapper/PerconaBootstrapper.tsx b/public/app/percona/shared/components/PerconaBootstrapper/PerconaBootstrapper.tsx index a7ca901d07c20..be1a330158e97 100644 --- a/public/app/percona/shared/components/PerconaBootstrapper/PerconaBootstrapper.tsx +++ b/public/app/percona/shared/components/PerconaBootstrapper/PerconaBootstrapper.tsx @@ -119,7 +119,7 @@ export const PerconaBootstrapper = ({ onReady }: PerconaBootstrapperProps) => {

{Messages.moreInfo} {Messages.alerting.howToUse}

{Messages.alerting.moreInfo} - + {Messages.alerting.docs} . @@ -81,11 +77,7 @@ export const getProductTourSteps = (

{Messages.advisors.pmmIncludes}

{Messages.advisors.findOutMore} - + {Messages.advisors.docs} . @@ -138,11 +130,7 @@ export const getProductTourSteps = (

{Messages.configPanel.settings}

{Messages.configPanel.settingsDocs}{' '} - + {Messages.configPanel.settingsDocsLink} . From 575c67701490794af490b5a64b27fca93529d050 Mon Sep 17 00:00:00 2001 From: Matej Kubinec Date: Wed, 2 Aug 2023 14:20:11 +0200 Subject: [PATCH 2/4] PMM-12310 Fix import & deprecated link --- .../components/Communication/Communication.messages.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/public/app/percona/settings/components/Communication/Communication.messages.ts b/public/app/percona/settings/components/Communication/Communication.messages.ts index 843c7920b9921..26c883a3bfc12 100644 --- a/public/app/percona/settings/components/Communication/Communication.messages.ts +++ b/public/app/percona/settings/components/Communication/Communication.messages.ts @@ -1,6 +1,6 @@ -import { HOW_TO_DOC_URL } from 'app/percona/settings/Settings.messages'; - -const COMMUNICATION_LINK = `${HOW_TO_DOC_URL}#communication`; +// page is deprecated, so shortener is not needed +const COMMUNICATION_LINK = + 'https://docs.percona.com/percona-monitoring-and-management/how-to/integrate-platform.html#disconnect-a-pmm-instance#communication'; export const Messages = { fields: { From 498b4104f40445e63f132b691d349758457e3441 Mon Sep 17 00:00:00 2001 From: Matej Kubinec Date: Wed, 2 Aug 2023 15:10:02 +0200 Subject: [PATCH 3/4] PMM-12310 Fix link --- .../settings/components/Communication/Communication.messages.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/app/percona/settings/components/Communication/Communication.messages.ts b/public/app/percona/settings/components/Communication/Communication.messages.ts index 26c883a3bfc12..fe7089cb5bd5d 100644 --- a/public/app/percona/settings/components/Communication/Communication.messages.ts +++ b/public/app/percona/settings/components/Communication/Communication.messages.ts @@ -1,6 +1,6 @@ // page is deprecated, so shortener is not needed const COMMUNICATION_LINK = - 'https://docs.percona.com/percona-monitoring-and-management/how-to/integrate-platform.html#disconnect-a-pmm-instance#communication'; + 'https://docs.percona.com/percona-monitoring-and-management/how-to/integrate-platform.html#communication'; export const Messages = { fields: { From d724f0f6f386c27b4f69f32ff486787630789905 Mon Sep 17 00:00:00 2001 From: Matej Kubinec Date: Wed, 16 Aug 2023 15:39:41 +0200 Subject: [PATCH 4/4] PMM-12310 Fix typo in footer documentation link --- public/app/core/components/Footer/Footer.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/app/core/components/Footer/Footer.tsx b/public/app/core/components/Footer/Footer.tsx index 72d2e0b0ebc6b..c639c67010bfd 100644 --- a/public/app/core/components/Footer/Footer.tsx +++ b/public/app/core/components/Footer/Footer.tsx @@ -25,7 +25,7 @@ export let getFooterLinks = (): FooterLink[] => { id: 'pmm-docs', text: 'Documentation', icon: 'document-info', - url: 'hhttps://per.co.na/pmm_documentation', + url: 'https://per.co.na/pmm_documentation', target: '_blank', }, {