Skip to content

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

Merged
merged 7 commits into from
Apr 29, 2025

Conversation

PeteGillinElastic
Copy link
Member

This does two things:

  • It describes what the timezone option actually does. The existing wording is misleading.
  • It recommends avoiding short abbreviations for timezones such as PST. This has come up at least twice recently.

@PeteGillinElastic PeteGillinElastic added v9.1.0 >docs General docs changes :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP labels Apr 26, 2025
@PeteGillinElastic PeteGillinElastic marked this pull request as ready for review April 28, 2025 08:01
@elasticsearchmachine elasticsearchmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels Apr 28, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

Copy link
Contributor

@lukewhiting lukewhiting left a 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:
Copy link
Contributor

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 :)

Copy link
Member Author

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 belows 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.

Copy link
Contributor

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 :)

Copy link
Member Author

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!)

@PeteGillinElastic PeteGillinElastic merged commit 35c2b25 into elastic:main Apr 29, 2025
6 checks passed
@PeteGillinElastic PeteGillinElastic deleted the date-processor-docs branch April 29, 2025 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants