Skip to content

[DOCS] Make Query DSL titles consistent #43935

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

Merged
merged 3 commits into from
Jul 18, 2019
Merged

[DOCS] Make Query DSL titles consistent #43935

merged 3 commits into from
Jul 18, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Jul 3, 2019

Changes

  • Adds title abbreviations for query type. This removes the " query" endings from most nav items but retains them for the on-page title.
  • Change titles to sentence case
  • Hyphenates some titles as needed.

Screenshots

Query DSL nav Query DSL nav
Example query title Example query title

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.0.2 v7.3.0 v7.1.2 v7.2.1 v7.4.0 labels Jul 3, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

@EmmanuelDemey
Copy link
Contributor

What about sorting alphabetically all these items ?

@jrodewig
Copy link
Contributor Author

jrodewig commented Jul 3, 2019

Thanks for the feedback @EmmanuelDemey. I've alphabetized the queries and some other nav items with bec3b2d.

I left some items, like context conceptual information and shared parameters, in the existing order.

@jpountz jpountz removed the v7.3.0 label Jul 5, 2019
@jrodewig jrodewig requested review from debadair and lcawl July 11, 2019 17:57
@jakelandis jakelandis added v7.2.2 and removed v7.2.1 labels Jul 15, 2019
@@ -1,5 +1,8 @@
[[query-dsl-match-query]]
=== Match Query
Copy link
Contributor

Choose a reason for hiding this comment

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

Should the "Query" be "query" here too?

=== Match Query

@lcawl
Copy link
Contributor

lcawl commented Jul 17, 2019

Should the capitalization also be changed in query-dsl-minimum-should-match.html and query-dsl-multi-term-rewrite.html ? Those are two pages in the Query DSL section that stand out now as having the old style of capitalization.

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

I added two comments, but otherwise LGTM and builds successfully

@jrodewig
Copy link
Contributor Author

Thanks for looking @lcawl. I fixed the missed match query and parameters with ecaa1ce.

@jrodewig
Copy link
Contributor Author

Ignoring elasticsearch-ci/docbldesx as elasticsearch-ci/docs replaced that check.

@jrodewig jrodewig merged commit ec37a9c into elastic:master Jul 18, 2019
@jrodewig jrodewig deleted the consistent-query-dsl-titles branch July 18, 2019 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search/Search Search-related issues that do not fall into other categories v7.0.2 v7.1.2 v7.2.2 v7.3.0 v7.4.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants