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

Feature/epmrpp 78881 add link to documentation #3618

Merged
merged 4 commits into from
Oct 30, 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
3 changes: 2 additions & 1 deletion app/localization/translated/be.json
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,8 @@
"DefectTypesTab.defectShortNameHint": "Абрэвіятура Тыпу Дэфекту павінна мець памер ад '1' да '4' сімвалаў",
"DefectTypesTab.deleteModalContent": "Вы ўпэўненыя, што хочаце выдаліць тып дэфекту? Усе дэфекты, якія прызнаныя '<b>{name}</b>', будуць адзначаны як '<b>{parentName}</b>'.",
"DefectTypesTab.deleteModalHeader": "Выдаліць тып дэфекту",
"DefectTypesTab.description": "Тыпы Дэфектаў - гэта набор дэфектаў, якія найбольш верагодна з'явяцца падчас выканання тэстаў. Вы можаце выкарыстоўваць Тыпы Дэфектаў па змаўчанні, каб пазначыць элементы тэсту, або стварыць уласныя Тыпы Дэфектаў, каб было прасцей аналізаваць выкананне тэстаў.",
"DefectTypesTab.description": "Тыпы Дэфектаў - гэта набор дэфектаў, якія найбольш верагодна з'явяцца падчас выканання тэстаў. Вы можаце выкарыстоўваць Тыпы Дэфектаў па змаўчанні, каб пазначыць элементы тэсту, або стварыць уласныя Тыпы Дэфектаў, каб было прасцей аналізаваць выкананне тэстаў. Больш падрабязную інфармацыю аб Тыпах Дэфектаў вы можаце прачытаць у",
"DefectTypesTab.documentation": "<a>Дакументацыі</a>.",
AmsterGet marked this conversation as resolved.
Show resolved Hide resolved
"DefectTypesTab.diagramCol": "Дыяграма",
"DefectTypesTab.informationMessage": "У вас засталося толькі {length} {slot} для стварэння тыпаў дэфектаў",
"DefectTypesTab.informationMessageMultiply": "слотаў",
Expand Down
3 changes: 2 additions & 1 deletion app/localization/translated/ru.json
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,8 @@
"DefectTypesTab.defectShortNameHint": "Аббревиатура Типа Дефекта должна иметь размер от '1' до '4' символов",
"DefectTypesTab.deleteModalContent": "Вы уверены, что хотите удалить тип дефекта? Все дефекты, которые признаны '<b>{name}</b>', будут отмечены как '<b>{parentName}</b>'.",
"DefectTypesTab.deleteModalHeader": "Удалить тип дефекта",
"DefectTypesTab.description": "Типы Дефектов — это набор дефектов, которые с наибольшей вероятностью могут появиться во время выполнения тестов. Вы можете использовать Типы Дефектов по умолчанию, чтобы пометить элементы теста, или создать свои собственные Типы Дефектов, чтобы упростить анализ выполнения тестов.",
"DefectTypesTab.description": "Типы Дефектов — это набор дефектов, которые с наибольшей вероятностью могут появиться во время выполнения тестов. Вы можете использовать Типы Дефектов по умолчанию, чтобы пометить элементы теста, или создать свои собственные Типы Дефектов, чтобы упростить анализ выполнения тестов. Более подробную информацию о Типах Дефектов вы можете прочитать в",
"DefectTypesTab.documentation": "<a>Документации</a>.",
"DefectTypesTab.diagramCol": "Диаграмма",
"DefectTypesTab.informationMessage": "У вас осталось только {length} {slot} для создания типов дефектов",
"DefectTypesTab.informationMessageMultiply": "слотов",
Expand Down
3 changes: 2 additions & 1 deletion app/localization/translated/uk.json
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,8 @@
"DefectTypesTab.defectShortNameHint": "Абревіатура Типу Дефекту повинна мати розмір від '1' до '4' символів",
"DefectTypesTab.deleteModalContent": "Вы уверены, что хотите удалить тип дефекта? Все дефекты, которые признаны '<b>{name}</b>', будут отмечены как '<b>{parentName}</b>'.",
"DefectTypesTab.deleteModalHeader": "Видалити дефекту тип",
"DefectTypesTab.description": "Типи Дефектів — це набір дефектів, які з найбільшою ймовірністю можуть з’явитися під час виконання тестів. Ви можете використовувати Типи Дефектів за замовчуванням, щоб позначити елементи тесту, або створити власні Типи Дефектів, щоб полегшити аналіз виконання тестів.",
"DefectTypesTab.description": "Типи Дефектів — це набір дефектів, які з найбільшою ймовірністю можуть з’явитися під час виконання тестів. Ви можете використовувати Типи Дефектів за замовчуванням, щоб позначити елементи тесту, або створити власні Типи Дефектів, щоб полегшити аналіз виконання тестів. Більш детальну інформацію про типи дефектів ви можете прочитати в",
"DefectTypesTab.documentation": "<a>Документації</a>.",
"DefectTypesTab.diagramCol": "Діаграма",
"DefectTypesTab.informationMessage": "У вас залишилося лише {length} {slot} для створення типів дефектів",
"DefectTypesTab.informationMessageMultiply": "слотів",
Expand Down
3 changes: 2 additions & 1 deletion app/localization/translated/zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,8 @@
"DefectTypesTab.defectShortNameHint": "简称的长度应为1到4个字符",
"DefectTypesTab.deleteModalContent": "您确定要删除此缺陷类型吗?所有被标记为“<b>{name}</b>”的缺陷都将被替换为“<b>{parentName}</b>”。",
"DefectTypesTab.deleteModalHeader": "删除缺陷类型",
"DefectTypesTab.description": "缺陷类型是在测试执行期间最有可能出现的一组缺陷。您可以使用默认缺陷类型来标记您的测试项,或创建自己的缺陷类型以便更轻松地分析测试执行。",
"DefectTypesTab.description": "Defect Types are a set of defects that are most likely to appear during tests execution. You can use default Defect Types to mark your test items or create your own Defect Types to make it easier to analyze tests execution. More information about Defect Types you can read in",
"DefectTypesTab.documentation": "<a>Documentation</a>.",
"DefectTypesTab.diagramCol": "图表",
"DefectTypesTab.informationMessage": "您只剩下{length}个{slot}可用于创建缺陷类型",
"DefectTypesTab.informationMessageMultiply": "可用缺陷类型",
Expand Down
1 change: 1 addition & 0 deletions app/src/common/utils/referenceDictionary.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ export const docsReferences = {
'https://reportportal.io/docs/reportportal-configuration/IntegrationViaPlugin',
authorizationWithUsersApiKeyForAgents:
'https://reportportal.io/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal/#2-authorization-with-users-api-key-for-agents',
workWithReports: 'https://reportportal.io/docs/work-with-reports/InvestigationOfFailure',
};
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ export const PROJECT_SETTINGS_DEFECT_TYPES_EVENTS = {
...BASIC_EVENT_PARAMETERS_DEFECT_TYPES,
icon_name: 'icon_create_defect',
},
CLICK_DOCUMENTATION_LINK: {
...BASIC_EVENT_PARAMETERS_DEFECT_TYPES,
link_name: 'documentation',
},
};

export const PROJECT_SETTINGS_INTEGRATION = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import {
import { SystemMessage } from 'componentLibrary/systemMessage';
import { COMMON_LOCALE_KEYS } from 'common/constants/localization';
import { PROJECT_SETTINGS_DEFECT_TYPES_EVENTS } from 'analyticsEvents/projectSettingsPageEvents';
import { docsReferences, createExternalLink } from 'common/utils';
import { SettingsPageContent } from '../settingsPageContent';
import { DefectTypeRow } from './defectTypeRow';
import { messages } from './defectTypesMessages';
Expand Down Expand Up @@ -101,6 +102,10 @@ export const DefectTypes = ({ setHeaderTitleNode }) => {
);
};

const onDocumentation = () => {
AmsterGet marked this conversation as resolved.
Show resolved Hide resolved
trackEvent(PROJECT_SETTINGS_DEFECT_TYPES_EVENTS.CLICK_DOCUMENTATION_LINK);
AmsterGet marked this conversation as resolved.
Show resolved Hide resolved
};

const defectTypesLength = useMemo(
() => DEFECT_TYPES_SEQUENCE.reduce((acc, groupName) => defectTypes[groupName].length + acc, 0),
[defectTypes],
Expand Down Expand Up @@ -147,7 +152,16 @@ export const DefectTypes = ({ setHeaderTitleNode }) => {

return (
<SettingsPageContent>
<TabDescription>{formatMessage(messages.description)}</TabDescription>
<TabDescription>
{formatMessage(messages.description)}{' '}
<span onClick={onDocumentation}>
{Parser(
formatMessage(messages.documentation, {
a: (data) => createExternalLink(data, docsReferences.workWithReports),
}),
)}
</span>
</TabDescription>
<Divider />
{(isInformationMessage || !canAddNewDefectType) && (
<div className={cx('system-message')}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ export const messages = defineMessages({
description: {
id: 'DefectTypesTab.description',
defaultMessage:
'Defect Types are a set of defects that are most likely to appear during tests execution. You can use default Defect Types to mark your test items or create your own Defect Types to make it easier to analyze tests execution.',
'Defect Types are a set of defects that are most likely to appear during tests execution. You can use default Defect Types to mark your test items or create your own Defect Types to make it easier to analyze tests execution. More information about Defect Types you can read in',
},
documentation: {
id: 'DefectTypesTab.documentation',
defaultMessage: '<a>Documentation</a>.',
},
informationTitle: {
id: 'DefectTypesTab.informationTitle',
Expand Down