Skip to content

Commit 89d3872

Browse files
author
Tommy Markley
authored
Fixes formatting and typos in documentation (#1697)
Resolves #592 Signed-off-by: Tommy Markley <[email protected]>
1 parent 3ff99cf commit 89d3872

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

TYPESCRIPT.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ The first thing that will probably happen when you convert a `.js` file in our s
1313

1414
#### EUI component is missing types
1515

16-
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.
17-
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.
16+
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.
1817

1918
```ts
2019
// typings/@elastic/eui/index.d.ts

packages/osd-eslint-import-resolver-opensearch-dashboards/lib/get_project_root.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ function getConfig(config) {
3838
projectRoot: true,
3939
};
4040

41-
if (!config || !config['@elastic/eslint-import-resolver-kibana']) return defaults;
42-
return Object.assign(defaults, config['@elastic/eslint-import-resolver-kibana']);
41+
if (!config || !config['@osd/eslint-import-resolver-opensearch-dashboards']) return defaults;
42+
return Object.assign(defaults, config['@osd/eslint-import-resolver-opensearch-dashboards']);
4343
}
4444

4545
function getRootPackageDir(dirRoot, dir, rootPackageName) {

src/core/server/saved_objects/migrations/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here is the gist of what happens if an index migration is necessary:
1919
- Create an alias `.opensearch_dashboards` that points to `.opensearch_dashboards_1`
2020
- Create a `.opensearch_dashboards_2` index
2121
- Copy all documents from `.opensearch_dashboards_1` into `.opensearch_dashboards_2`, running them through any applicable migrations
22-
- # Point the `.opensearch_dashboards` alias to `.opensearch_dashboards_2`
22+
- Point the `.opensearch_dashboards` alias to `.opensearch_dashboards_2`
2323

2424
## Migrating OpenSearch Dashboards clusters
2525

@@ -30,7 +30,7 @@ If OpenSearch Dashboards is being run in a cluster, migrations will be coordinat
3030
- opensearch-dashboards-2 tries to begin the migration, but fails with the error `.opensearch_dashboards_4 already exists`
3131
- opensearch-dashboards-2 logs that it failed to create the migration index, and instead begins polling
3232
- Every few seconds, opensearch-dashboards-2 instance checks the `.opensearch_dashboards` index to see if it is done migrating
33-
- # Once `.opensearch_dashboards` is determined to be up to date, the opensearch-dashboards-2 instance continues booting
33+
- Once `.opensearch_dashboards` is determined to be up to date, the opensearch-dashboards-2 instance continues booting
3434

3535
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.
3636

0 commit comments

Comments
 (0)