You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue tracks release notes for the 8.4.0 release, which is GAing on August 23, 2022.
Set up the release notes
Before starting the release notes, do the following:
Set up a new release notes file
Update the release notes index file (release-notes.asciidoc)
Prep the breaking changes section in the Stack docs (breaking.asciidoc)
Prep the breaking changes in the Security docs (8.4.asciidoc)
Set up the release notes file
Create a new release notes file for major and minor releases. To create the file, follow these steps:
Check out the main branch.
Run git fetch origin then git pull to pull in the latest changes.
Run git -b <branch name> to create a new branch. For example, git -b issue-2175-8.4.0-rn.
Open the Security docs in your text editor (Atom or VS Code) and navigate to the release-notes folder.
Create a new asciidoc file in the release-notes folder. NOTE: Remember to include the asciidoc file extension when you name the file.
Add a heading anchor to the top of the file. It should be [[release-notes-header-8.4.0]]. You'll be referencing this anchor later when you insert a cross reference to the 8.4.0 release notes into the release notes index file (release-notes.asciidoc).
Under the heading anchor, add the page title. It should be: == 8.3.
Save the changes and open a PR.
Update the release notes index file
Insert a cross reference to the appropriate release notes file and add the release notes to the main TOC.
Open the release-notes.asciidoc file.
Under the section that summarizes the changes in each release, add a cross reference to the 8.4.0 release notes. It should be: * <<release-notes-8.4.0, {elastic-sec} version 8.4.0>>.
Go the end of the file and add an include for the the 8.4.0 release notes. It should be: include::release-notes/8.4.asciidoc[]
Save the changes and push them to your release notes PR.
Prep the breaking changes section in the Stack docs
To link the "Breaking changes" section in the Security release notes from the Elastic Installation and Upgrade guide:
Pull in the latest changes from the stack-docs repo's main branch.
Open the stack-docs repo in your text editor and navigate to the breaking.asciidoc file.
Go to the "Elastic Security breaking changes" section and make the following changes:
Update the release version number that's included in the URL that references the latest Security release notes. For this release, the referenced URL should be: {security-guide-all}/8.4/release-notes-header-8.4.0.html#breaking-changes-8.4.0[{elastic-sec} breaking changes]
Update the include statement so it refences the 8.4 release notes asciidoc file. For this release, ensure the include statement is: include::{security-repo-dir}/release-notes/8.4.asciidoc[tag=breaking-changes]
Save your changes and open a PR. You can model the issue and PR for updating the Stack doc's breaking.asciidoc file after:
Prep the breaking changes section in the Security docs
Return to your 8.4 release notes branch in the Security docs and open the 8.4 release notes file (8.4.asciidoc).
Insert the Breaking Changes section above the Features section. Copy and paste the following:
[discrete]
[[breaking-changes-8.4.0]]
==== Breaking changes
// tag::breaking-changes[]
// NOTE: The breaking-changes tagged regions are re-used in the Elastic Installation and Upgrade Guide. The pull attribute is defined within this snippet so it properly resolves in the output.
:pull: https://github.com/elastic/kibana/pull/
**TBD**
// end::breaking-changes[]
Save the changes and push them to your release notes PR.
Links inside tagged content must be full URL links, not relative links or an internal anchor references. Using attributes to represent part of the URL is OK. Basically, treat links as if they're external or cross-document links.
The text was updated successfully, but these errors were encountered:
Make sure to add the following summary to the fixed issues section:
Isolates the query used for the First seen and Last seen fields on the Users, Hosts, and Network details pages to improve page load times and UI performance ({pull}133539[#133539]).
This was removed from the 8.3.3 RN because it was only merged into the 8.4 branch.
Description
This issue tracks release notes for the 8.4.0 release, which is GAing on August 23, 2022.
Set up the release notes
Before starting the release notes, do the following:
release-notes.asciidoc
)breaking.asciidoc
)8.4.asciidoc
)Set up the release notes file
Create a new release notes file for major and minor releases. To create the file, follow these steps:
main
branch.git fetch origin
thengit pull
to pull in the latest changes.git -b <branch name>
to create a new branch. For example,git -b issue-2175-8.4.0-rn
.release-notes
folder.release-notes
folder.NOTE: Remember to include the
asciidoc
file extension when you name the file.[[release-notes-header-8.4.0]]
. You'll be referencing this anchor later when you insert a cross reference to the 8.4.0 release notes into the release notes index file (release-notes.asciidoc
).== 8.3
.Update the release notes index file
Insert a cross reference to the appropriate release notes file and add the release notes to the main TOC.
release-notes.asciidoc
file.* <<release-notes-8.4.0, {elastic-sec} version 8.4.0>>
.include::release-notes/8.4.asciidoc[]
Prep the breaking changes section in the Stack docs
To link the "Breaking changes" section in the Security release notes from the Elastic Installation and Upgrade guide:
stack-docs
repo'smain
branch.stack-docs
repo in your text editor and navigate to thebreaking.asciidoc
file.{security-guide-all}/8.4/release-notes-header-8.4.0.html#breaking-changes-8.4.0[{elastic-sec} breaking changes]
8.4
release notes asciidoc file. For this release, ensure the include statement is:include::{security-repo-dir}/release-notes/8.4.asciidoc[tag=breaking-changes]
breaking.asciidoc
file after:NOTE: The CI checks for your Stack docs PR will fail until you've merged your PR for the 8.4 Security release notes into the
main
and8.4
branches.Prep the breaking changes section in the Security docs
8.4.asciidoc
).Troubleshooting
The text was updated successfully, but these errors were encountered: