Skip to content

[DOCS] Copy glossary content from Stack Docs glossary #759

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.

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

Closed
wants to merge 1 commit into from
Closed

[DOCS] Copy glossary content from Stack Docs glossary #759

wants to merge 1 commit into from

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 28, 2019

This PR copies content from the Stack Docs glossary.

It also adds a few Elasticsearch definitions missing from the original Stack Docs glossary:

Why make this change?

The end goal is to use this file as a single source for both the Elasticsearch and Stack Docs glossaries.

After this PR is merged, I'll open separate PRs to:

  1. Update the Elasticsearch glossary to include terms from this file.
  2. Update the Stack Docs glossary to include terms from this file.

See elastic/elasticsearch#40560 for more discussion.

@nik9000
Copy link
Member

nik9000 commented Mar 28, 2019

I'm not a fan of putting this in the docs repo because we don't have proper up-to-date checking on it. Also, it feels like content instead of helpers which feels weird to have in the docs repo. I admit I've not really thought out my last point, but the up-to-date checking still makes this a less good idea than it looks on the face of it.

@jrodewig
Copy link
Contributor Author

@nik9000 I think up-to-date checking is a big and valid concern. Added the team-discuss label so we can talk about this more before moving forward.

I'm happy to close this PR. At the very least, it revealed some definitions that weren't synced which I can fix in a separate PR if we go another route.

@jrodewig jrodewig changed the title Copy glossary content from Stack Docs glossary [DOCS] Copy glossary content from Stack Docs glossary Mar 28, 2019
@jrodewig
Copy link
Contributor Author

jrodewig commented Apr 4, 2019

We discussed this internally and decide to go with a many-to-one approach (individual solution repos feeding into a combine glossary).

Closing this PR.

@jrodewig jrodewig closed this Apr 4, 2019
@jrodewig jrodewig deleted the move-glossary-content-from-stack-docs branch April 4, 2019 18:49
@gtback gtback removed the blocked label May 14, 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.

3 participants