Skip to content

[DOCS] Add metadata to ML pages#802

Closed
lcawl wants to merge 1 commit intoelastic:masterfrom
lcawl:metadata
Closed

[DOCS] Add metadata to ML pages#802
lcawl wants to merge 1 commit intoelastic:masterfrom
lcawl:metadata

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Jan 10, 2020

This PR plays with adding Asciidoctor metadata to the machine learning content per https://asciidoctor.org/docs/user-manual/#metadata

In particular, this PR adds the page's content type (reference/concept/etc) as keyword metadata. It results in the following, for example:

<head>
<meta name="keywords" content="concepts">

The values that we put in the "tags" and "subject" field in the https://github.com/elastic/docs/blob/master/conf.yaml, on the other hand, apply to every page in the book and are output as follows:

<head>
<meta name="DC.type" content="Learn/Docs/Elastic Stack/Machine learning/master">
<meta name="DC.subject" content="Machine learning">

Another option: "You can add content, such as custom metadata, stylesheet, and script information, to the header of the output document using docinfo ("document information" files)". For example, we can have docinfo files that apply to all documents in the same directory. See https://asciidoctor.org/docs/user-manual/#docinfo-file

@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Feb 13, 2020

Closing until we get further with discussions on how we're using this metadata

@lcawl lcawl closed this Feb 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants