github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Code] improve setup guide (#38218) (#38226)

Browse source
This commit is contained in:
Yulong 2019-06-06 16:12:13 +08:00 • committed by GitHub
parent 5170349676
commit e20d5b88ce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 68 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

106
x-pack/plugins/code/public/components/admin_page/setup_guide.tsx
View file

@ -13,6 +13,7 @@ import {
EuiSteps,
EuiText,
EuiTitle,
EuiLink,
} from '@elastic/eui';
import React from 'react';
import { connect } from 'react-redux';
@ -22,79 +23,94 @@ import { RootState } from '../../reducers';
const steps = [
{
title: 'Configure Kibana Code Instance for Multiple Kibana Nodes',
title: 'Check if multiple Kibana instances are used as a cluster',
children: (
<EuiText>
<p>If you are using single Kibana instance, you can skip this step.</p>
<p>
If you are using multiple Kibana nodes, then you need to configure 1 Kibana instance as
Code instance. Please add the following line of code into your kibana.yml file for every
instance to indicate your Code instance:
If you are using multiple Kibana instances, you need to assign one Kibana instance as
`Code node`. To do this, add the following line of code into your kibana.yml file of every
Kibana instance and restart the instances:
</p>
<pre>
<code>xpack.code.codeNodeUrl: 'http://$YourCodeNodeAddress'</code>
</pre>
<p>Then, restart every Kibana instance.</p>
</EuiText>
),
},
{
title: 'Download and install language servers',
children: (
<EuiText>
<p>
If you need code intelligence support for your repos, you need to install the language
server for the programming languages.
</p>
<p />
<h5>PRE-INSTALLED LANGUAGE SERVERS:</h5>
<p />
TypeScript
<p />
<h5>AVAILABLE LANGUAGE SERVERS:</h5>
<p />
Java
<p />
<Link to="/admin?tab=LanguageServers">Manage language server installation</Link>
</EuiText>
),
},
{
title: 'Import a repository from a git address',
children: (
<EuiText>
<p>
You can add a repo to Code by simply putting in the git address of the repo. Usually this
is the same git address you use to run the git clone command, you can find more details
about the formats of git addresses that Code accepts&nbsp;
<a href={documentationLinks.gitFormat}>here</a>.
Where `$YourCodeNoteAddress` is the URL of your assigned Code node accessible by other
Kibana instances.
</p>
</EuiText>
),
},
{
title: 'Verify that your repo has been successfully imported',
title: 'Install extra language support optionally',
children: (
<EuiText>
<p>
Once the repo is added and indexed successfully, you can verify that the repo is
searchable and the code intelligence is available. You can find more details of how the
search and code intelligence work in{' '}
<a href={documentationLinks.codeIntelligence}>our docs</a>.
Look{' '}
<EuiLink href={documentationLinks.codeInstallLangServer} target="_blank">
here
</EuiLink>{' '}
to learn more about supported languages and language server installation.
</p>
<p>
If you need Java language support, you can manage language server installation{' '}
<Link to="/admin?tab=LanguageServers">here</Link>
</p>
</EuiText>
),
},
{
title: 'Add a repository to Code',
children: (
<EuiText>
<p>
Import{' '}
<EuiLink href={documentationLinks.codeGettingStarted} target="_blank">
{' '}
a sample repo
</EuiLink>{' '}
or{' '}
<EuiLink href={documentationLinks.codeRepoManagement} target="_blank">
your own repo
</EuiLink>
. It is as easy as copy and paste git clone URLs to Code.
</p>
</EuiText>
),
},
{
title: 'Verify the repo is successfully imported',
children: (
<EuiText>
<p>
You can verify your repo is successfully imported by{' '}
<EuiLink href={documentationLinks.codeSearch} target="_blank">
searching
</EuiLink>{' '}
and{' '}
<EuiLink href={documentationLinks.codeOtherFeatures} target="_blank">
navigating
</EuiLink>{' '}
the repo. If language support is available to the repo, also make sure{' '}
<EuiLink href={documentationLinks.semanticNavigation} target="_blank">
Semantic Navigation
</EuiLink>{' '}
is available as well.
</p>
</EuiText>
),
},
];
// TODO add link to learn more button
const toastMessage = (
<div>
<p>
We’ve made some changes to roles and permissions in Kibana. Read more about what these changes
mean for you below.{' '}
</p>
<EuiButton size="s" href="">
Learn More
<EuiButton size="s" href={documentationLinks.kibanaRoleManagement}>
Learn more
</EuiButton>
</div>
);

7
x-pack/plugins/code/public/lib/documentation_links.ts
View file

@ -11,4 +11,11 @@ export const documentationLinks = {
code: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code.html`,
codeIntelligence: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code.html`,
gitFormat: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/code.html`,
codeInstallLangServer: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/code-install-language-server.html`,
codeGettingStarted: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/code-getting-started.html`,
codeRepoManagement: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/code-repo-management.html`,
codeSearch: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/code-search.html`,
codeOtherFeatures: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/code-other-navigation-features.html`,
semanticNavigation: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/code-semantic-code-navigation.html`,
kibanaRoleManagement: `${ELASTIC_WEBSITE_URL}guide/en/kibana/7.2/_kibana_role_management.html`,
};