-
Notifications
You must be signed in to change notification settings - Fork 25.2k
Add info to date
processor docs
#127434
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
Add info to date
processor docs
#127434
Conversation
cbc8f5d
to
59eab0b
Compare
2f34a95
to
a1502b4
Compare
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-data-management (Team:Data Management) |
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.
Nice additional clarity here 👍🏻 LGTM
@@ -25,6 +24,14 @@ $$$date-options$$$ | |||
| `on_failure` | no | - | Handle failures for the processor. See [Handling pipeline failures](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md#handling-pipeline-failures). | | |||
| `tag` | no | - | Identifier for the processor. Useful for debugging and metrics. | | |||
|
|||
The `timezone` option may have two effects on the behavior of the processor: |
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.
Idea: If you gave this section a heading you could link to it from the table instead of writing (see below)
Looking at the URL preview, there are no subheadings at all on this page which makes it hard to scan :)
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.
Oh, that's a good idea. I've just added a bunch of section headings, and turned both the below
s into links. (I previewed the docs locally and the cross-references work as expected, so hopefully I got the format right.)
I've still left it saying 'see below', because I needed something as an anchor text. If there's a preference for a different style, please let me know.
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.
Nice! Made a suggestion to incorporate link into the text more naturally :)
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.
Thanks, yeah, that's better. Done. (I somehow mashed the wrong button in github and failed to apply your suggestion, but I've pushed a commit with the exact same change!)
This does two things:
timezone
option actually does. The existing wording is misleading.PST
. This has come up at least twice recently.