-
Notifications
You must be signed in to change notification settings - Fork 25k
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
Fix macros in changelog #30269
Fix macros in changelog #30269
Conversation
docs/CHANGELOG.asciidoc
Outdated
|
||
= Elasticsearch Release Notes | ||
|
||
== Elasticsearch 7.0.0 | ||
|
||
=== Breaking Changes | ||
|
||
<<write-thread-pool-fallback, Removed `thread_pool.bulk.*` settings and | ||
`es.thread_pool.write.use_bulk_as_display_name` system property>> ({pull}29609[#29609]) | ||
write-thread-pool-fallback, Removed `thread_pool.bulk.*` settings and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this supposed to be a link to https://www.elastic.co/guide/en/elasticsearch/reference/master/breaking_70_settings_changes.html#write-thread-pool-fallback ?
docs/CHANGELOG.asciidoc
Outdated
|
||
= Elasticsearch Release Notes | ||
|
||
== Elasticsearch 7.0.0 | ||
|
||
=== Breaking Changes | ||
|
||
<<write-thread-pool-fallback, Removed `thread_pool.bulk.*` settings and | ||
`es.thread_pool.write.use_bulk_as_display_name` system property>> ({pull}29609[#29609]) | ||
write-thread-pool-fallback, Removed `thread_pool.bulk.*` settings and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This edit is wrong. This is a link, hence <<,>>
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The edits to the cross-doc links are not right.
This reverts commit 385f2fa.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@jasontedor I reverted the incorrect changes, thanks for the catch! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
* origin/master: [test] add java packaging test project (elastic#30161) Fix macros in changelog (elastic#30269) [DOCS] Fixes syskeygen command name [ML] Include 3rd party C++ component notices (elastic#30132) _cluster/state Skip Test for pre-6.4, not pre-7.0 (elastic#30264) Improve docs for disk watermarks (elastic#30249) [DOCS] Removes redundant Active Directory realm settings (elastic#30190) [DOCS] Removes redundant LDAP realm settings (elastic#30193) _cluster/state should always return cluster_uuid (elastic#30143) HTML5ify Javadoc for core and test framework (elastic#30234) Minor tweaks to reroute documentation (elastic#30246)
I had mistakenly commented out two helpful macros for the changelog, which caused the generated docs not to look correct. This PR fixes linking to issues and pull requests with
:link:
and:pull:
Steps I took to test this PR:
if necessary,
git clone git@github.com:elastic/docs.git
and install appropriate perl stuffs, we'll be using thebuild_docs.pl
script.from
elasticsearch
dir, runperl ../docs/build_docs.pl --doc docs/CHANGELOG.asciidoc --open --lenient
. This should open up a browser linking you to localhostconfirm pull request links show up correctly, etc.
Before:
After: