Skip to content

Commit

Permalink
[8.13] [Ent Search] Fix connector client UI copy (#179579) (#179799)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.13`:
- [[Ent Search] Fix connector client UI copy
(#179579)](#179579)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Liam
Thompson","email":"32779855+leemthompo@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-04-02T09:12:33Z","message":"[Ent
Search] Fix connector client UI copy (#179579)\n\nFixes broken copy
instructions and updates
links","sha":"a38196699eddc283b41d259c64c70b0162736ab3","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:EnterpriseSearch","v8.14.0","v8.13.1"],"title":"[Ent
Search] Fix connector client UI
copy","number":179579,"url":"#179579
Search] Fix connector client UI copy (#179579)\n\nFixes broken copy
instructions and updates
links","sha":"a38196699eddc283b41d259c64c70b0162736ab3"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"#179579
Search] Fix connector client UI copy (#179579)\n\nFixes broken copy
instructions and updates
links","sha":"a38196699eddc283b41d259c64c70b0162736ab3"}},{"branch":"8.13","label":"v8.13.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
  • Loading branch information
kibanamachine and leemthompo committed Apr 2, 2024
1 parent 1585675 commit 8e587d3
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 46 deletions.
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/get_doc_links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
bulkApi: `${ELASTICSEARCH_DOCS}docs-bulk.html`,
configuration: `${ENTERPRISE_SEARCH_DOCS}configuration.html`,
connectors: `${ENTERPRISE_SEARCH_DOCS}connectors.html`,
connectorsClientDeploy: `${ENTERPRISE_SEARCH_DOCS}deploy-connector-client.html`,
connectorsMappings: `${ENTERPRISE_SEARCH_DOCS}connectors-usage.html#connectors-usage-index-create-configure-existing-index`,
connectorsAzureBlobStorage: `${ENTERPRISE_SEARCH_DOCS}connectors-azure-blob.html`,
connectorsBox: `${ENTERPRISE_SEARCH_DOCS}connectors-box.html`,
Expand Down
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ export interface DocLinks {
readonly bulkApi: string;
readonly configuration: string;
readonly connectors: string;
readonly connectorsClientDeploy: string;
readonly connectorsMappings: string;
readonly connectorsAzureBlobStorage: string;
readonly connectorsBox: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ export const ConnectorConfiguration: React.FC = () => {
i18n.translate(
'xpack.enterpriseSearch.content.connectorDetail.configuration.apiKey.noApiKeyLabel',
{
defaultMessage: 'Please set an index name before generating an API key',
defaultMessage:
'Before you can generate an API key, you need to attach an index. Scroll to the bottom of this page for instructions.',
}
)
),
Expand All @@ -112,41 +113,21 @@ export const ConnectorConfiguration: React.FC = () => {
{
children: (
<>
<EuiText size="s">
<FormattedMessage
id="xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.secondParagraph"
defaultMessage="The connectors repository contains several {link}. Use our framework to accelerate developing connectors for custom data sources."
values={{
link: (
<EuiLink
href="https://github.com/elastic/connectors-python/tree/main/connectors"
target="_blank"
external
>
{i18n.translate(
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.clientExamplesLink',
{ defaultMessage: 'connector client examples' }
)}
</EuiLink>
),
}}
/>
</EuiText>
<EuiSpacer />
<EuiText size="s">
<FormattedMessage
id="xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.thirdParagraph"
defaultMessage="In this step, you will need to clone or fork the repository, and copy the generated API key and connector ID to the associated {link}. The connector ID will identify this connector to Search. The service type will determine which type of data source the connector is configured for."
defaultMessage="In this step, you will need to clone or fork the elastic/connectors repository, and copy the API key and connector ID values to the config.yml file. Here's an {exampleLink}."
values={{
link: (
exampleLink: (
<EuiLink
href="https://github.com/elastic/connectors-python/blob/main/config.yml"
href="https://github.com/elastic/connectors-python/blob/main/config.yml.example"
target="_blank"
external
>
{i18n.translate(
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.configurationFileLink',
{ defaultMessage: 'configuration file' }
{ defaultMessage: 'example config file' }
)}
</EuiLink>
),
Expand All @@ -166,13 +147,24 @@ export const ConnectorConfiguration: React.FC = () => {
</EuiCodeBlock>
<EuiSpacer />
<EuiText size="s">
{i18n.translate(
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorDeployedText',
{
defaultMessage:
'Once configured, deploy the connector on your infrastructure.',
}
)}
<FormattedMessage
id="xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.fourthParagraph"
defaultMessage="Because this connector is self-managed, you need to deploy the connector service on your own infrastructure. You can build from source or use Docker. Refer to the {link} for your deployment options."
values={{
link: (
<EuiLink
href={docLinks.connectorsClientDeploy}
target="_blank"
external
>
{i18n.translate(
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.deploymentModeLink',
{ defaultMessage: 'documentation' }
)}
</EuiLink>
),
}}
/>
</EuiText>
</>
),
Expand All @@ -183,7 +175,7 @@ export const ConnectorConfiguration: React.FC = () => {
title: i18n.translate(
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.steps.deployConnector.title',
{
defaultMessage: 'Deploy connector',
defaultMessage: 'Set up and deploy connector',
}
),
titleSize: 'xs',
Expand Down Expand Up @@ -259,7 +251,7 @@ export const ConnectorConfiguration: React.FC = () => {
title: i18n.translate(
'xpack.enterpriseSearch.content.connector_detail.configurationConnector.steps.enhance.title',
{
defaultMessage: 'Enhance your connector client',
defaultMessage: 'Configure your connector',
}
),
titleSize: 'xs',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ class DocLinks {
public clientsRustOverview: string;
public cloudIndexManagement: string;
public connectors: string;
public connectorsClientDeploy: string;
public connectorsMappings: string;
public connectorsAzureBlobStorage: string;
public connectorsBox: string;
Expand Down Expand Up @@ -240,6 +241,7 @@ class DocLinks {
this.clientsRustOverview = '';
this.cloudIndexManagement = '';
this.connectors = '';
this.connectorsClientDeploy = '';
this.connectorsMappings = '';
this.connectorsAzureBlobStorage = '';
this.connectorsBox = '';
Expand Down Expand Up @@ -418,6 +420,7 @@ class DocLinks {
this.connectors = docLinks.links.enterpriseSearch.connectors;
this.connectorsMappings = docLinks.links.enterpriseSearch.connectorsMappings;
this.connectorsAzureBlobStorage = docLinks.links.enterpriseSearch.connectorsAzureBlobStorage;
this.connectorsClientDeploy = docLinks.links.enterpriseSearch.connectorsClientDeploy;
this.connectorsBox = docLinks.links.enterpriseSearch.connectorsBox;
this.connectorsConfluence = docLinks.links.enterpriseSearch.connectorsConfluence;
this.connectorsContentExtraction = docLinks.links.enterpriseSearch.connectorsContentExtraction;
Expand Down
4 changes: 0 additions & 4 deletions x-pack/plugins/translations/translations/fr-FR.json
Original file line number Diff line number Diff line change
Expand Up @@ -14038,8 +14038,6 @@
"xpack.enterpriseSearch.connectorStats.incompleteBadgeLabel": "{number} incomplet(s)",
"xpack.enterpriseSearch.connectorStats.runningSyncsTextLabel": "{syncs} synchronisations en cours",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorConnected": "Votre connecteur {name} s'est bien connecté à Search.",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.secondParagraph": "Le référentiel de connecteurs contient plusieurs {link}. Utilisez notre cadre pour accélérer le développement de connecteurs pour des sources de données personnalisées.",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.thirdParagraph": "Dans cette étape, vous devez cloner ou dupliquer le référentiel, puis copier la clé d'API et l'ID de connecteur générés au {link} associé. L'ID de connecteur identifiera ce connecteur auprès de Search. Le type de service détermine pour quel type de source de données le connecteur est configuré.",
"xpack.enterpriseSearch.content.connectors.connectorsTable.columns.actions.viewIndex.caption": "Voir l'index {connectorName}",
"xpack.enterpriseSearch.content.connectors.connectorTable.column.actions.deleteIndex": "Supprimer le connecteur {connectorName}",
"xpack.enterpriseSearch.content.connectors.deleteModal.syncsWarning.indexNameDescription": "Cette action ne peut pas être annulée. Veuillez saisir {connectorName} pour confirmer.",
Expand Down Expand Up @@ -15328,9 +15326,7 @@
"xpack.enterpriseSearch.content.analytics.api.generateAnalyticsApiKeyModal.title": "Créer une clé d'API d'analyse",
"xpack.enterpriseSearch.content.cannotConnect.body": "En savoir plus.",
"xpack.enterpriseSearch.content.cannotConnect.title": "Impossible de se connecter à Enterprise Search",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.clientExamplesLink": "exemples de clients connecteurs",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.configurationFileLink": "fichier de configuration",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorDeployedText": "Une fois le connecteur configuré, déployez-le dans votre infrastructure.",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnector.button.label": "Revérifier maintenant",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnectorText": "Votre connecteur ne s'est pas connecté à Search. Résolvez vos problèmes de configuration et actualisez la page.",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnectorTitle": "En attente de votre connecteur",
Expand Down
4 changes: 0 additions & 4 deletions x-pack/plugins/translations/translations/ja-JP.json
Original file line number Diff line number Diff line change
Expand Up @@ -14018,8 +14018,6 @@
"xpack.enterpriseSearch.connectorStats.incompleteBadgeLabel": "{number}件が未完了です",
"xpack.enterpriseSearch.connectorStats.runningSyncsTextLabel": "{syncs}実行中の同期",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorConnected": "コネクター{name}は、正常にSearchに接続されました。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.secondParagraph": "コネクターリポジトリには複数の{link}が含まれています。当社のフレームワークを使用すると、カスタムデータソース用のコネクターの開発を加速できます。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.thirdParagraph": "このステップでは、リポジトリを複製または分割し、関連付けられた{link}に対する生成されたAPIキーとコネクターIDをコピーします。コネクターIDは、Searchに対するこのコネクターを特定します。サービスタイプは、コネクターが構成されているデータソースのタイプを決定します。",
"xpack.enterpriseSearch.content.connectors.connectorsTable.columns.actions.viewIndex.caption": "インデックス{connectorName}を表示",
"xpack.enterpriseSearch.content.connectors.connectorTable.column.actions.deleteIndex": "コネクター\"{connectorName}\"を削除",
"xpack.enterpriseSearch.content.connectors.deleteModal.syncsWarning.indexNameDescription": "この操作は元に戻すことができません。{connectorName}を入力して確認してください。",
Expand Down Expand Up @@ -15307,9 +15305,7 @@
"xpack.enterpriseSearch.content.analytics.api.generateAnalyticsApiKeyModal.title": "分析APIキーを作成",
"xpack.enterpriseSearch.content.cannotConnect.body": "詳細。",
"xpack.enterpriseSearch.content.cannotConnect.title": "エンタープライズ サーチに接続できません",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.clientExamplesLink": "コネクタークライアントの例",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.configurationFileLink": "構成ファイル",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorDeployedText": "構成したら、インフラでコネクターをデプロイします。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnector.button.label": "今すぐ再確認",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnectorText": "コネクターはSearchに接続されていません。構成のトラブルシューティングを行い、ページを更新してください。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnectorTitle": "コネクターを待機しています",
Expand Down
4 changes: 0 additions & 4 deletions x-pack/plugins/translations/translations/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -14044,8 +14044,6 @@
"xpack.enterpriseSearch.connectorStats.incompleteBadgeLabel": "{number} 个未完成",
"xpack.enterpriseSearch.connectorStats.runningSyncsTextLabel": "{syncs} 个正在运行的同步",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorConnected": "您的连接器 {name} 已成功连接到 Search。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.secondParagraph": "连接器存储库包含几个 {link}。使用我们的框架可加速为定制数据源开发连接器。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.description.thirdParagraph": "在此步骤中,您需要克隆或分叉存储库,然后将生成的 API 密钥和连接器 ID 复制到关联的 {link}。连接器 ID 会将此连接器标识到 Search。此服务类型将决定要将连接器配置用于哪些类型的数据源。",
"xpack.enterpriseSearch.content.connectors.connectorsTable.columns.actions.viewIndex.caption": "查看索引 {connectorName}",
"xpack.enterpriseSearch.content.connectors.connectorTable.column.actions.deleteIndex": "删除连接器 {connectorName}",
"xpack.enterpriseSearch.content.connectors.deleteModal.syncsWarning.indexNameDescription": "此操作无法撤消。请尝试 {connectorName} 以确认。",
Expand Down Expand Up @@ -15334,9 +15332,7 @@
"xpack.enterpriseSearch.content.analytics.api.generateAnalyticsApiKeyModal.title": "创建分析 API 密钥",
"xpack.enterpriseSearch.content.cannotConnect.body": "更多信息。",
"xpack.enterpriseSearch.content.cannotConnect.title": "无法连接到 Enterprise Search",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.clientExamplesLink": "连接器客户端示例",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.configurationFileLink": "配置文件",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.connectorDeployedText": "配置后,请在您的基础设施上部署连接器。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnector.button.label": "立即重新检查",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnectorText": "您的连接器尚未连接到 Search。排除配置故障并刷新页面。",
"xpack.enterpriseSearch.content.connector_detail.configurationConnector.connectorPackage.waitingForConnectorTitle": "等候您的连接器",
Expand Down

0 comments on commit 8e587d3

Please sign in to comment.