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.

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

Updating documentation for new datetime format #6337

Merged
merged 6 commits into from
Feb 8, 2024

Conversation

CaptainDredge
Copy link
Contributor

@CaptainDredge CaptainDredge commented Feb 2, 2024

Description

This PR updates documentation for new datetime format rfc_3339_lenient

Issues Resolved

Closes #6308

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@hdhalter
Copy link
Collaborator

hdhalter commented Feb 2, 2024

Thanks, @CaptainDredge ! Did you mean to link this to issue #6308? Is the content ready for doc review?

@Naarcha-AWS Naarcha-AWS self-assigned this Feb 2, 2024
@CaptainDredge
Copy link
Contributor Author

Thanks, @CaptainDredge ! Did you mean to link this to issue #6308? Is the content ready for doc review?

Thanks @hdhalter I've linked to the right issue. The content is ready for review but I'm not able to figure out what exact formatting is required for CI to go green. Is there any automated linter for the docs?

@hdhalter hdhalter added 4 - Doc Review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v2.12.0 labels Feb 5, 2024
Prabhat Sharma and others added 2 commits February 5, 2024 15:17
Signed-off-by: Prabhat Sharma <ptsharma@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Prabhat <20185657+CaptainDredge@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 4 - Doc Review PR: Doc review in progress labels Feb 6, 2024
@Naarcha-AWS
Copy link
Collaborator

Moving to done, we should update Vale rules so that an emdash isn't always required.

@kolchfa-aws
Copy link
Collaborator

Endash is required in text but this is literal strings so they should be in code format. Let me make some suggestions.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Looking at this, we should change all string literals to have code format. @CaptainDredge If you'd like to take this on, that would be great. Otherwise, we can address this in a separate issue. Thanks!

_field-types/supported-field-types/date.md Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits February 8, 2024 14:20
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS merged commit bb9c8c5 into opensearch-project:main Feb 8, 2024
3 checks passed
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Feb 13, 2024
oeyh pushed a commit to oeyh/documentation-website that referenced this pull request Mar 14, 2024
* Updating documentation for new datetime format introduced in OS 2.12

Signed-off-by: Prabhat Sharma <ptsharma@amazon.com>

* Update _field-types/supported-field-types/date.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Prabhat <20185657+CaptainDredge@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update date.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Prabhat Sharma <ptsharma@amazon.com>
Signed-off-by: Prabhat <20185657+CaptainDredge@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Prabhat Sharma <ptsharma@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] New Datetime format rfc3339_lenient
4 participants