From e04b5558e9f9324a485684174831cc905d2486ae Mon Sep 17 00:00:00 2001 From: Tommy Markley Date: Mon, 13 Jun 2022 18:38:19 -0500 Subject: [PATCH] Fixes formatting and typos in documentation (#1697) Resolves #592 Signed-off-by: Tommy Markley --- TYPESCRIPT.md | 3 +-- .../lib/get_project_root.js | 4 ++-- src/core/server/saved_objects/migrations/README.md | 4 ++-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/TYPESCRIPT.md b/TYPESCRIPT.md index 4fb9c39415c2..4ce378ec4af7 100644 --- a/TYPESCRIPT.md +++ b/TYPESCRIPT.md @@ -13,8 +13,7 @@ The first thing that will probably happen when you convert a `.js` file in our s #### EUI component is missing types -1. Check https://github.com/elastic/eui/issues/256 to see if they know it’s missing, if it’s not on there, add it. -2. Temporarily get around the issue by adding the missing type in the `typings/@elastic/eui/index.d.ts` file. Bonus points if you write a PR yourself to the EUI repo to add the types, but having them available back in OpenSearch Dashboards will take some time, as a new EUI release will need to be generated, then that new release pointed to in OpenSearch Dashboards. Best, to make forward progress, to do a temporary workaround. +Temporarily get around the issue by adding the missing type in the `typings/@elastic/eui/index.d.ts` file. Bonus points if you write a PR yourself to the EUI repo to add the types, but having them available back in OpenSearch Dashboards will take some time, as a new EUI release will need to be generated, then that new release pointed to in OpenSearch Dashboards. Best, to make forward progress, to do a temporary workaround. ```ts // typings/@elastic/eui/index.d.ts diff --git a/packages/osd-eslint-import-resolver-opensearch-dashboards/lib/get_project_root.js b/packages/osd-eslint-import-resolver-opensearch-dashboards/lib/get_project_root.js index d2523267bd1c..30fef8d22c88 100755 --- a/packages/osd-eslint-import-resolver-opensearch-dashboards/lib/get_project_root.js +++ b/packages/osd-eslint-import-resolver-opensearch-dashboards/lib/get_project_root.js @@ -38,8 +38,8 @@ function getConfig(config) { projectRoot: true, }; - if (!config || !config['@elastic/eslint-import-resolver-kibana']) return defaults; - return Object.assign(defaults, config['@elastic/eslint-import-resolver-kibana']); + if (!config || !config['@osd/eslint-import-resolver-opensearch-dashboards']) return defaults; + return Object.assign(defaults, config['@osd/eslint-import-resolver-opensearch-dashboards']); } function getRootPackageDir(dirRoot, dir, rootPackageName) { diff --git a/src/core/server/saved_objects/migrations/README.md b/src/core/server/saved_objects/migrations/README.md index 1c2348913495..eadcf7e244ce 100644 --- a/src/core/server/saved_objects/migrations/README.md +++ b/src/core/server/saved_objects/migrations/README.md @@ -19,7 +19,7 @@ Here is the gist of what happens if an index migration is necessary: - Create an alias `.opensearch_dashboards` that points to `.opensearch_dashboards_1` - Create a `.opensearch_dashboards_2` index - Copy all documents from `.opensearch_dashboards_1` into `.opensearch_dashboards_2`, running them through any applicable migrations -- # Point the `.opensearch_dashboards` alias to `.opensearch_dashboards_2` +- Point the `.opensearch_dashboards` alias to `.opensearch_dashboards_2` ## Migrating OpenSearch Dashboards clusters @@ -30,7 +30,7 @@ If OpenSearch Dashboards is being run in a cluster, migrations will be coordinat - opensearch-dashboards-2 tries to begin the migration, but fails with the error `.opensearch_dashboards_4 already exists` - opensearch-dashboards-2 logs that it failed to create the migration index, and instead begins polling - Every few seconds, opensearch-dashboards-2 instance checks the `.opensearch_dashboards` index to see if it is done migrating - - # Once `.opensearch_dashboards` is determined to be up to date, the opensearch-dashboards-2 instance continues booting + - Once `.opensearch_dashboards` is determined to be up to date, the opensearch-dashboards-2 instance continues booting In this example, if the `.opensearch_dashboards_4` index existed prior to OpenSearch Dashboards booting, the entire migration process will fail, as all OpenSearch Dashboards instances will assume another instance is migrating to the `.opensearch_dashboards_4` index. This problem is only fixable by deleting the `.opensearch_dashboards_4` index.