[6.8] [DOCS] Adds kibana-pull attribute for release docs (#69554) (#69579)

This commit is contained in:
Lisa Cawley 2020-06-23 08:57:17 -07:00 committed by GitHub
parent 0d7471f741
commit 5d14cf2062
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 2432 additions and 2397 deletions

File diff suppressed because it is too large Load diff

View file

@ -85,5 +85,5 @@ node ../../kibana/scripts/functional_test_runner
[float]
==== Using esArchiver
We're working on documentation for this, but for now the best place to look is the original {pull}10359[pull request].
We're working on documentation for this, but for now the best place to look is the original {kibana-pull}10359[pull request].

View file

@ -107,7 +107,11 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
});
-----------
<<<<<<< HEAD
Full details are {repo}tree/6.7/packages/kbn-i18n#vanilla-js[here].
=======
Full details are {kib-repo}tree/master/packages/kbn-i18n#vanilla-js[here].
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
[float]
===== i18n for React
@ -131,7 +135,11 @@ export const Component = () => {
};
-----------
<<<<<<< HEAD
Full details are {repo}tree/6.7/packages/kbn-i18n#react[here].
=======
Full details are {kib-repo}tree/master/packages/kbn-i18n#react[here].
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
@ -152,7 +160,11 @@ The translation directive has the following syntax:
></ANY>
-----------
<<<<<<< HEAD
Full details are {repo}tree/6.7/packages/kbn-i18n#angularjs[here].
=======
Full details are {kib-repo}tree/master/packages/kbn-i18n#angularjs[here].
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
[float]

View file

@ -9,6 +9,7 @@ Many Kibana developers hang out on `irc.freenode.net` in the `#kibana` channel.
[float]
==== Some light reading
<<<<<<< HEAD
- Our {repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going
- Tim Roes' excellent blog series https://www.timroes.de/2016/02/21/writing-kibana-plugins-custom-applications/[Writing Kibana Plugins]
@ -16,11 +17,18 @@ Many Kibana developers hang out on `irc.freenode.net` in the `#kibana` channel.
==== Videos
- https://www.elastic.co/elasticon/2015/sf/contributors-guide-to-the-kibana-galaxy[Contributors Guide to the Kibana Galaxy]
- https://www.elastic.co/elasticon/conf/2016/sf/how-to-build-your-own-kibana-plugins[Kibana Plugin Dev - Elasticon 2016]
=======
Our {kib-repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going.
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
[float]
==== Plugin Generator
<<<<<<< HEAD
It is recommended that you kick-start your plugin by generating it with the {repo}tree/{branch}/packages/kbn-plugin-generator[Kibana Plugin Generator]. Run the following within the Kibana repo and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play within Kibana's sibling `kibana-extra` folder.
=======
We recommend that you kick-start your plugin by generating it with the {kib-repo}tree/{branch}/packages/kbn-plugin-generator[Kibana Plugin Generator]. Run the following in the Kibana repo, and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play with in Kibana's `plugins` folder.
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
["source","shell"]
-----------
@ -43,7 +51,11 @@ The Kibana directory must be named `kibana`, and your plugin directory must be l
[float]
==== References in the code
<<<<<<< HEAD
- {repo}blob/{branch}/src/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
=======
- {kib-repo}blob/{branch}/src/legacy/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
- <<development-uiexports>>: What type of exports are available?
[float]
@ -71,4 +83,15 @@ Plugin code can be written in http://www.typescriptlang.org/[TypeScript] if desi
}
-----------
<<<<<<< HEAD
TypeScript code is automatically converted into JavaScript during development, but not in the distributable version of Kibana. If you use the {repo}blob/{branch}/packages/kbn-plugin-helpers[@kbn/plugin-helpers] to build your plugin then your `.ts` and `.tsx` files will be permanently transpiled before your plugin is archived. If you have your own build process, make sure to run the TypeScript compiler on your source files and ship the compilation output so that your plugin will work with the distributable version of Kibana.
=======
TypeScript code is automatically converted into JavaScript during development,
but not in the distributable version of Kibana. If you use the
{kib-repo}blob/{branch}/packages/kbn-plugin-helpers[@kbn/plugin-helpers] to build your plugin, then your `.ts` and `.tsx` files will be permanently transpiled before your plugin is archived. If you have your own build process, make sure to run the TypeScript compiler on your source files and ship the compilation output so that your plugin will work with the distributable version of Kibana.
==== {kib} platform migration guide
{kib-repo}blob/{branch}/src/core/MIGRATION.md#migrating-legacy-plugins-to-the-new-platform[This guide]
provides an action plan for moving a legacy plugin to the new platform.
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)

View file

@ -18,4 +18,12 @@ However, these docs will be kept up-to-date to reflect the current implementatio
include::development-embedding-visualizations.asciidoc[]
include::development-create-visualization.asciidoc[]
<<<<<<< HEAD
include::development-create-visualization.asciidoc[]
=======
* The <<breaking-changes,breaking changes>> documentation, where we try to capture any changes to the APIs as they occur across minors.
* link:https://github.com/elastic/kibana/issues/44121[Meta issue] which is tracking the move of the plugin to the new Kibana platform
* Our link:https://www.elastic.co/blog/join-our-elastic-stack-workspace-on-slack[Elastic Stack workspace on Slack].
* The {kib-repo}blob/{branch}/src/plugins/visualizations[source code], which will continue to be
the most accurate source of information.
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)

View file

@ -11,14 +11,10 @@ release-state can be: released | prerelease | unreleased
:docker-image: docker.elastic.co/kibana/kibana:{version}
:es-ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/
:kibana-ref: https://www.elastic.co/guide/en/kibana/{branch}
:xpack-ref: https://www.elastic.co/guide/en/x-pack/current/
:repo: https://github.com/elastic/kibana/
:issue: {repo}issues/
:pull: {repo}pull/
:commit: {repo}commit/
:security: https://www.elastic.co/community/security/
include::{docs-root}/shared/attributes.asciidoc[]
include::introduction.asciidoc[]
include::setup/install.asciidoc[]

View file

@ -11,11 +11,7 @@ include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
:docker-repo: docker.elastic.co/kibana/kibana
:docker-image: docker.elastic.co/kibana/kibana:{version}
:repo: https://github.com/elastic/kibana/
:issue: {repo}issues/
:pull: {repo}pull/
:commit: {repo}commit/
:blob: {repo}blob/{branch}/
:blob: {kib-repo}blob/{branch}/
:security-ref: https://www.elastic.co/community/security/
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

View file

@ -11,7 +11,7 @@ See also <<release-highlights>> and <<release-notes>>.
[float]
=== Saved objects `bulk_get` and `find` endpoints renamed
//{pull}17512[#17512]
//{kib-pull}17512[#17512]
*Details:*
To support sending larger and more expressive queries to the Saved Objects find

View file

@ -68,4 +68,4 @@ Use it to create, edit and embed visualizations, and also to search inside an em
* https://github.com/datasweet-fr/kibana-datasweet-formula[Datasweet Formula] (datasweet) - enables calculated metric on any standard Kibana visualization.
* https://github.com/pjhampton/kibana-prometheus-exporter[Prometheus Exporter] - exports the Kibana metrics in the prometheus format
NOTE: If you want your plugin to be added to this page, open a {repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request].
NOTE: If you want your plugin to be added to this page, open a {kib-repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request].

View file

@ -111,7 +111,7 @@ ASCIIDOC
}
my $number = $issue->{number};
# print encode_utf8("* $title {pull}${number}[#${number}]");
# print encode_utf8("* $title {kibana-pull}${number}[#${number}]");
print encode_utf8("* $title");
print "\n";
print encode_utf8("// https://github.com/${User_Repo}pull/${number}[#${number}]");
@ -120,7 +120,7 @@ ASCIIDOC
print keys %uniq > 1
? " (issues: "
: " (issue: ";
# print join ", ", map {"{issue}${_}[#${_}]"}
# print join ", ", map {"{kib-issue}${_}[#${_}]"}
# print join ", ", map {"#${_}"}
print join ", ", map {"https://github.com/${User_Repo}issues/${_}[#${_}]"}
sort keys %uniq;