Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from Oct 30, 2018
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04b5339
add warning to the documentation_links file about link validation gotcha
Bargs Oct 29, 2018
eeb7840
Use Clint's full name
Oct 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/ui/public/documentation_links/documentation_links.ts
View file
Open in desktop
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 Clint first so he can update his Perl scripts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe expand, Clint Gormley, for new devs who may not know which Clint :)

*/
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