Skip to content

Commit 7770927

Browse files
committed
[DOCS] Adds kibana-pull attribute for release docs (#69554)
1 parent 0d7471f commit 7770927

8 files changed

Lines changed: 51 additions & 16 deletions

docs/developer/plugin/development-plugin-functional-tests.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,5 @@ node ../../kibana/scripts/functional_test_runner
8585
[float]
8686
==== Using esArchiver
8787

88-
We're working on documentation for this, but for now the best place to look is the original {pull}10359[pull request].
88+
We're working on documentation for this, but for now the best place to look is the original {kibana-pull}10359[pull request].
8989

docs/developer/plugin/development-plugin-localization.asciidoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,11 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
107107
});
108108
-----------
109109

110+
<<<<<<< HEAD
110111
Full details are {repo}tree/6.7/packages/kbn-i18n#vanilla-js[here].
112+
=======
113+
Full details are {kib-repo}tree/master/packages/kbn-i18n#vanilla-js[here].
114+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
111115
112116
[float]
113117
===== i18n for React
@@ -131,7 +135,11 @@ export const Component = () => {
131135
};
132136
-----------
133137
138+
<<<<<<< HEAD
134139
Full details are {repo}tree/6.7/packages/kbn-i18n#react[here].
140+
=======
141+
Full details are {kib-repo}tree/master/packages/kbn-i18n#react[here].
142+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
135143

136144

137145

@@ -152,7 +160,11 @@ The translation directive has the following syntax:
152160
></ANY>
153161
-----------
154162

163+
<<<<<<< HEAD
155164
Full details are {repo}tree/6.7/packages/kbn-i18n#angularjs[here].
165+
=======
166+
Full details are {kib-repo}tree/master/packages/kbn-i18n#angularjs[here].
167+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
156168
157169
158170
[float]

docs/developer/plugin/development-plugin-resources.asciidoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,26 @@ Many Kibana developers hang out on `irc.freenode.net` in the `#kibana` channel.
99

1010
[float]
1111
==== Some light reading
12+
<<<<<<< HEAD
1213
- Our {repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going
1314
- Tim Roes' excellent blog series https://www.timroes.de/2016/02/21/writing-kibana-plugins-custom-applications/[Writing Kibana Plugins]
1415

1516
[float]
1617
==== Videos
1718
- https://www.elastic.co/elasticon/2015/sf/contributors-guide-to-the-kibana-galaxy[Contributors Guide to the Kibana Galaxy]
1819
- https://www.elastic.co/elasticon/conf/2016/sf/how-to-build-your-own-kibana-plugins[Kibana Plugin Dev - Elasticon 2016]
20+
=======
21+
Our {kib-repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going.
22+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
1923
2024
[float]
2125
==== Plugin Generator
2226
27+
<<<<<<< HEAD
2328
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.
29+
=======
30+
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.
31+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
2432

2533
["source","shell"]
2634
-----------
@@ -43,7 +51,11 @@ The Kibana directory must be named `kibana`, and your plugin directory must be l
4351

4452
[float]
4553
==== References in the code
54+
<<<<<<< HEAD
4655
- {repo}blob/{branch}/src/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
56+
=======
57+
- {kib-repo}blob/{branch}/src/legacy/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
58+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)
4759
- <<development-uiexports>>: What type of exports are available?
4860
4961
[float]
@@ -71,4 +83,15 @@ Plugin code can be written in http://www.typescriptlang.org/[TypeScript] if desi
7183
}
7284
-----------
7385
86+
<<<<<<< HEAD
7487
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.
88+
=======
89+
TypeScript code is automatically converted into JavaScript during development,
90+
but not in the distributable version of Kibana. If you use the
91+
{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.
92+
93+
==== {kib} platform migration guide
94+
95+
{kib-repo}blob/{branch}/src/core/MIGRATION.md#migrating-legacy-plugins-to-the-new-platform[This guide]
96+
provides an action plan for moving a legacy plugin to the new platform.
97+
>>>>>>> d26cbef389... [DOCS] Adds kibana-pull attribute for release docs (#69554)

docs/developer/visualize/development-visualize-index.asciidoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,12 @@ However, these docs will be kept up-to-date to reflect the current implementatio
1818

1919
include::development-embedding-visualizations.asciidoc[]
2020

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

docs/gs-index.asciidoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,10 @@ release-state can be: released | prerelease | unreleased
1111

1212
:docker-image: docker.elastic.co/kibana/kibana:{version}
1313
:es-ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/
14-
:kibana-ref: https://www.elastic.co/guide/en/kibana/{branch}
15-
:xpack-ref: https://www.elastic.co/guide/en/x-pack/current/
16-
:repo: https://github.com/elastic/kibana/
17-
:issue: {repo}issues/
18-
:pull: {repo}pull/
19-
:commit: {repo}commit/
2014
:security: https://www.elastic.co/community/security/
2115

16+
include::{docs-root}/shared/attributes.asciidoc[]
17+
2218
include::introduction.asciidoc[]
2319

2420
include::setup/install.asciidoc[]

docs/index.asciidoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@ include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
1111

1212
:docker-repo: docker.elastic.co/kibana/kibana
1313
:docker-image: docker.elastic.co/kibana/kibana:{version}
14-
:repo: https://github.com/elastic/kibana/
15-
:issue: {repo}issues/
16-
:pull: {repo}pull/
17-
:commit: {repo}commit/
18-
:blob: {repo}blob/{branch}/
14+
:blob: {kib-repo}blob/{branch}/
1915
:security-ref: https://www.elastic.co/community/security/
2016

2117
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

docs/plugins/known-plugins.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ Use it to create, edit and embed visualizations, and also to search inside an em
6868
* https://github.com/datasweet-fr/kibana-datasweet-formula[Datasweet Formula] (datasweet) - enables calculated metric on any standard Kibana visualization.
6969
* https://github.com/pjhampton/kibana-prometheus-exporter[Prometheus Exporter] - exports the Kibana metrics in the prometheus format
7070

71-
NOTE: If you want your plugin to be added to this page, open a {repo}tree/{branch}/docs/plugins/known-plugins.asciidoc[pull request].
71+
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].

x-pack/dev-tools/xkb_release_notes.pl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ sub dump_issues {
111111
}
112112
my $number = $issue->{number};
113113

114-
# print encode_utf8("* $title {pull}${number}[#${number}]");
114+
# print encode_utf8("* $title {kibana-pull}${number}[#${number}]");
115115
print encode_utf8("* $title");
116116
print "\n";
117117
print encode_utf8("// https://github.com/${User_Repo}pull/${number}[#${number}]");
@@ -120,7 +120,7 @@ sub dump_issues {
120120
print keys %uniq > 1
121121
? " (issues: "
122122
: " (issue: ";
123-
# print join ", ", map {"{issue}${_}[#${_}]"}
123+
# print join ", ", map {"{kib-issue}${_}[#${_}]"}
124124
# print join ", ", map {"#${_}"}
125125
print join ", ", map {"https://github.com/${User_Repo}issues/${_}[#${_}]"}
126126
sort keys %uniq;

0 commit comments

Comments
 (0)