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.

Sign up for GitHub

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

[index pattern field editor] Update runtime field painless docs url #100014

Merged
merged 4 commits into from
May 13, 2021
Merged

[index pattern field editor] Update runtime field painless docs url #100014

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e7e9ea4
update runtime field painless docs url
mattkime May 13, 2021
36d3295
Merge branch 'master' into update_runtime_syntax_docs_url
kibanamachine May 13, 2021
183c173
better url code
mattkime May 13, 2021
e476ad7
Merge branch 'update_runtime_syntax_docs_url' of github.com:mattkime/…
mattkime May 13, 2021
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: 1 addition & 2 deletions src/plugins/index_pattern_field_editor/public/lib/documentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@ import { DocLinksStart } from 'src/core/public';
export const getLinks = (docLinks: DocLinksStart) => {
const { DOC_LINK_VERSION, ELASTIC_WEBSITE_URL } = docLinks;
const docsBase = `${ELASTIC_WEBSITE_URL}guide/en`;
const esDocsBase = `${docsBase}/elasticsearch/reference/${DOC_LINK_VERSION}`;
const painlessDocsBase = `${docsBase}/elasticsearch/painless/${DOC_LINK_VERSION}`;

return {
runtimePainless: `${esDocsBase}/runtime.html#runtime-mapping-fields`,
runtimePainless: `${docsBase}/kibana/master/managing-index-patterns.html#runtime-fields`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think instead of hard-coding a version in here, it'd be preferrable to define a const instead. For example:

const kibanaDocsBase = ${docsBase}/kibana/${DOC_LINK_VERSION}`;

Then return the URL like this:

runtimePainless: ${kibanaDocsBase}/managing-index-patterns.html#runtime-fields,

painlessSyntax: `${painlessDocsBase}/painless-lang-spec.html`,
};
};