maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add warning to the documentation_links file about link validation gotcha (#24786)

Browse source 
* add warning to the documentation_links file about link validation gotcha

* Use Clint's full name
This commit is contained in:
Matt Bargar 2018-10-30 15:16:07 -04:00 committed by GitHub
parent 04568fcca6
commit 19e18ef121
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/ui/public/documentation_links/documentation_links.ts
View file

@ -19,6 +19,11 @@
import { metadata } from '../metadata';
/*
WARNING: The links in this file are validated during the docs build. This is accomplished with some regex magic that
looks for these particular constants. As a result, we should not add new constants or change the existing ones.
If you absolutely must make a change, talk to Clinton Gormley first so he can update his Perl scripts.
*/
export const DOC_LINK_VERSION = metadata.branch;
export const ELASTIC_WEBSITE_URL = 'https://www.elastic.co/';
const ELASTIC_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${DOC_LINK_VERSION}/`;