Skip to content

Commit

Permalink
Add warning to the documentation_links file about link validation got…
Browse files Browse the repository at this point in the history
…cha (#24786)

* add warning to the documentation_links file about link validation gotcha

* Use Clint's full name
  • Loading branch information
Bargs authored Oct 30, 2018
1 parent 04568fc commit 19e18ef
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/ui/public/documentation_links/documentation_links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}/`;
Expand Down

0 comments on commit 19e18ef

Please sign in to comment.