Skip to content

Backfill changelogs for 8.1.0 #83341

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
Feb 4, 2022
Merged

Conversation

pugnascotia
Copy link
Contributor

@pugnascotia pugnascotia commented Jan 31, 2022

We want to use the new release notes generation process for 8.1.0. In order to do that, we need to backfill the docs/changelog directory with YAML files, to account for the time period up until we started generating YAML
files for all applicable PRs.

Also:

  • Deprecation information ought to be split into "details" and "impact", so use the same Breaking class for both. Note that this will require a HOMER change as well.
  • Prune changelogs for previous releases
  • Remove dry-run mode from the prune task, it's superfluous
  • Lots and lots of tweaks and fixes

I intend to do another pass before 8.1.0 is released, in order to check that we haven't missed any PRs that ought to have YAML files, and to ensure we don't have any lurking files that ought to have been removed.

@pugnascotia pugnascotia added >non-issue :Delivery/Tooling Developer tooliing and automation v8.1.0 labels Jan 31, 2022
@elasticmachine elasticmachine added the Team:Delivery Meta label for Delivery team label Jan 31, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@pugnascotia
Copy link
Contributor Author

@ywelsch you have some PRs labelled release highlight for 8.1.0, and my PR here has generated changelog YAML files for them. I don't know what to put in the extended release highlight information for these - can you please provide me with the text, or update the YAML files on this branch?

Copy link
Contributor

@mark-vieira mark-vieira left a comment

Choose a reason for hiding this comment

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

One minor comment, otherwise LGTM.

@pugnascotia pugnascotia added the >docs General docs changes label Feb 2, 2022
@pugnascotia pugnascotia requested a review from jrodewig February 2, 2022 15:03
@mark-vieira mark-vieira added v8.2.0 and removed v8.1.0 labels Feb 2, 2022
@jrodewig
Copy link
Contributor

jrodewig commented Feb 3, 2022

@elasticmachine run elasticsearch-ci/docs

jrodewig added a commit to elastic/stack-docs that referenced this pull request Feb 3, 2022
Removing this while we get the 8.2 migration guide in place in elastic/elasticsearch#83341
@jrodewig
Copy link
Contributor

jrodewig commented Feb 3, 2022

@elasticmachine run elasticsearch-ci/docs

@jrodewig jrodewig added the v8.1.1 label Feb 3, 2022
@jrodewig
Copy link
Contributor

jrodewig commented Feb 3, 2022

It looks like master went from 8.1 to 8.2 while this PR was open. When you regenerated the release notes, it looks like it switched everything from 8.1 to 8.2.

I pushed elastic/stack-docs@83a16f2 to swap it back. I don't know if there's a good way to prevent this in the future, but it may be something we want to document.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM overall. I left a couple of minor nits, and an edit for @ywelsch.

Thanks for putting this together!

* Copy `trace.id` in threadcontext stash {es-pull}83218[#83218]

Infra/Scripting::
* Fix duplicated allow lists upon script engine creation {es-pull}82820[#82820] (issue: {es-issue}82778[#82778])
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this one be here? It looks to be 8.0.0-rc2.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I went trawling through git for this, and I can only find the commit on the 8.1 and master branches, but it doesn't exist on 8.0, so I have to assume the change didn't actually make it into the branch that the labels claim. This is why we need the new process 👍

- 80021
area: Search
type: enhancement
summary: Support combining `_shards` preference param with <custom-string>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
summary: Support combining `_shards` preference param with <custom-string>
summary: Support combining `_shards` preference param with `<custom-string>`

Comment on lines 14 to 21
Doc-value-only fields allow users to trade slower query performance for
an increased indexing rate and storage space efficiency. This is
achieved by disabling inverted structures such as the inverted index or
points, and using the columnar storage format of doc values to run
queries instead, while still providing the same usual great performance
for aggregating and sorting data. {es} {version} supports term and
range queries on `numeric`, `date`, `keyword`, `ip`, and `boolean`
doc-value-only field types.
Copy link
Contributor

@jrodewig jrodewig Feb 4, 2022

Choose a reason for hiding this comment

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

@ywelsch Let me know what you think of these changes. I tried to address two minor issues:

  • I wasn't sure if "date" included date_nanos. It does, but it wasn't clear from this text.
  • I'm not sure we needed the info about the internal data structures and storage formats. Those felt like implementation details to me and are a little redundant with the doc value docs, but let me know what you think.
Suggested change
Doc-value-only fields allow users to trade slower query performance for
an increased indexing rate and storage space efficiency. This is
achieved by disabling inverted structures such as the inverted index or
points, and using the columnar storage format of doc values to run
queries instead, while still providing the same usual great performance
for aggregating and sorting data. {es} {version} supports term and
range queries on `numeric`, `date`, `keyword`, `ip`, and `boolean`
doc-value-only field types.
You can now run `term` and `range` queries on numeric, `date`, `date_nanos`,
`keyword`, `ip`, and `boolean` fields that only store doc values.
In exchange for slower queries, doc-value-only fields offer:
* Increased indexing rates
* Better storage efficiency
* Great performance for aggregating and sorting data
For more information about doc values, refer to the
{ref}/doc-values.html[`doc_values` mapping parameter documentation].

I'd be great if we had a mapping example of a doc-value-only field we could link to from here.

Copy link
Contributor

Choose a reason for hiding this comment

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

@jrodewig I missed this ping here, sorry. I'm not sure if this made it in. Note that I've since amended the docs here: #84209
It now provides an example and linkable section.

Copy link
Contributor

Choose a reason for hiding this comment

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

Awesome. Thanks, @ywelsch!

# this support
highlight:
notable: false
title: Doc-values-only search is now supported on numeric, date, keyword, ip, and boolean types
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: Doc-values-only search is now supported on numeric, date, keyword, ip, and boolean types
title: Doc-values-only search on numeric, `date`, `date_nanos`, `keyword`, `ip`, and `boolean` fields

@pugnascotia pugnascotia changed the base branch from master to 8.1 February 4, 2022 11:19
@pugnascotia pugnascotia merged commit 4cd2a43 into elastic:8.1 Feb 4, 2022
@pugnascotia pugnascotia deleted the backfill-changelogs branch February 4, 2022 14:36
pugnascotia added a commit to pugnascotia/elasticsearch that referenced this pull request Feb 4, 2022
Forward-port of the `build-tools-internal` parts of elastic#83341.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Tooling Developer tooliing and automation >docs General docs changes >non-issue Team:Delivery Meta label for Delivery team v8.1.1 v8.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants