Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix deprecation in history retention docs #53655

Merged
merged 3 commits into from
Mar 17, 2020
Merged

Fix deprecation in history retention docs #53655

merged 3 commits into from
Mar 17, 2020

Conversation

DaveCTurner
Copy link
Contributor

This commit adjusts a deprecation[...] message in the docs since such
messages must be on a single line. It also moves this message to the start of
the description of the deprecated setting as is the case with other such
messages.

@DaveCTurner
Fix deprecation in history retention docs
2761b2d 
This commit adjusts a `deprecation[...]` message in the docs since such
messages must be on a single line. It also moves this message to the start of
the description of the deprecated setting as is the case with other such
messages.
@DaveCTurner DaveCTurner added >docs General docs changes :Distributed Indexing/Engine Anything around managing Lucene and the Translog in an open shard. v8.0.0 v7.7.0 v7.6.3 labels Mar 17, 2020
@DaveCTurner DaveCTurner requested a review from dnhatn March 17, 2020 10:51
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Engine)

@DaveCTurner
Copy link
Contributor Author

Ugh, preview at http://elasticsearch_53655.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/index-modules-history-retention.html indicates this is still wrong, but I've no idea why. I guessed c07e3c0.

@DaveCTurner
Copy link
Contributor Author

Ok, latest preview looks good.

jrodewig
jrodewig approved these changes Mar 17, 2020
View reviewed changes
Copy link
Contributor

@jrodewig jrodewig left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM.

Just as a note: This also changes the deprecation notice from a block (using ::) to inline (using :). I think that's appropriate here tho. Here are the deprecation tag docs if that helps next time:

https://github.com/elastic/docs#additions-and-deprecations

@DaveCTurner
Copy link
Contributor Author

Thanks @jrodewig. Any idea why 2761b2d didn't work?

Also, in the docs you linked there's an example that uses deprecated[...] rather than deprecated:[...]. Is that right?

@jrodewig
Copy link
Contributor

Re: 2761b2d, the deprecated[...] tag expected there to be additional text on the same line.

So change:

`index.soft_deletes.enabled`::
  deprecated[7.6, Creating indices with soft-deletes disabled is deprecated and will be removed in future Elasticsearch versions.]
Whether...

To:

`index.soft_deletes.enabled`::
  deprecated[7.6, Creating indices with soft-deletes disabled is deprecated and will be removed in future Elasticsearch versions.] Whether...

This is sort of the reason why we're moving away from the deprecated[...] syntax. It technically isn't supported in Asciidoctor. The docs build does some work to convert them to deprecated:[...] or deprecated::[...] based on context, but the rules aren't clear and sometimes result in odd renders like this.

Thanks for pointing out the inconsistency in those docs. I'll get that fixed.

@DaveCTurner DaveCTurner merged commit 1f439a2 into elastic:master Mar 17, 2020
@DaveCTurner DaveCTurner deleted the 2020-03-17-fix-deprecation-in-history-retention-docs branch March 17, 2020 14:04
DaveCTurner added a commit that referenced this pull request Mar 17, 2020
@DaveCTurner
Fix deprecation in history retention docs (#53655)
347b759 
This commit adjusts a `deprecation[...]` message in the docs since such
messages must be on a single line. It also moves this message to the start of
the description of the deprecated setting as is the case with other such
messages.
DaveCTurner added a commit that referenced this pull request Mar 17, 2020
@DaveCTurner
Fix deprecation in history retention docs (#53655)
f10c245 
This commit adjusts a `deprecation[...]` message in the docs since such
messages must be on a single line. It also moves this message to the start of
the description of the deprecated setting as is the case with other such
messages.
@dnhatn
Copy link
Member

dnhatn commented Mar 17, 2020

LGTM2. Thanks David.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrodewig jrodewig jrodewig approved these changes

@dnhatn dnhatn Awaiting requested review from dnhatn

Assignees
No one assigned
Labels
:Distributed Indexing/Engine Anything around managing Lucene and the Translog in an open shard. >docs General docs changes v7.6.3 v7.7.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@DaveCTurner @elasticmachine @jrodewig @dnhatn @jakelandis