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

[Jekyll] Spec Insert Plugin #8692

Merged
merged 14 commits into from
Nov 11, 2024

Conversation

nhtruong
Copy link
Contributor

@nhtruong nhtruong commented Nov 7, 2024

A program that insert API Components generated from the OpenSearch OpenAPI Spec into markdown files

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.

Copy link

github-actions bot commented Nov 7, 2024

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

A program that insert API Components generated from the OpenSearch OpenAPI Spec into markdown files

Signed-off-by: Theo Truong <[email protected]>
@nhtruong nhtruong force-pushed the spec_insert_phase_1 branch from 5741da0 to 869d2ae Compare November 7, 2024 16:13
@nhtruong nhtruong changed the title Spec Insert [Jekyll] Spec Insert Plugin Nov 7, 2024
Signed-off-by: Theo Truong <[email protected]>
Signed-off-by: Theo Truong <[email protected]>
@nhtruong nhtruong marked this pull request as ready for review November 7, 2024 21:40
Signed-off-by: Theo Truong <[email protected]>
Signed-off-by: Theo Truong <[email protected]>
@nhtruong nhtruong requested a review from dblock November 7, 2024 21:57
@nhtruong
Copy link
Contributor Author

nhtruong commented Nov 7, 2024

@dblock Would you mind taking a look? Thanks

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

This is very simple and clean! :shipit: 🚢

All my comments are nice to have and can be done in a future iteration.

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
spec-insert/jekyll-spec-insert.gemspec Outdated Show resolved Hide resolved
spec-insert/lib/doc_processor.rb Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
nhtruong and others added 3 commits November 8, 2024 10:09
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: Theo N. Truong <[email protected]>
@nhtruong
Copy link
Contributor Author

nhtruong commented Nov 8, 2024

All my comments are nice to have and can be done in a future iteration.
@dblock Github let me apply most of your suggestions with a few clicks so it was no big deal :D

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS self-assigned this Nov 8, 2024
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

This looks good to me. Before we merge, going to put the developer guide through editorial review.

@Naarcha-AWS Naarcha-AWS added the 5 - Editorial review PR: Editorial review in progress label Nov 8, 2024
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS @nhtruong Please see my comments and changes and let me know if you have any questions. Thanks!

DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
DEVELOPER_GUIDE.md Show resolved Hide resolved
DEVELOPER_GUIDE.md Outdated Show resolved Hide resolved
@@ -0,0 +1,135 @@
# Developer guide
- [Introduction](#introduction)
- [Starting the Jekyll server locally](#starting-the-jekyll-server-locally)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Also please correct links where necessary.

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit d4bb0f5 into opensearch-project:main Nov 11, 2024
8 checks passed
@nhtruong nhtruong deleted the spec_insert_phase_1 branch November 12, 2024 15:53
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
* Spec Insert
A program that insert API Components generated from the OpenSearch OpenAPI Spec into markdown files

Signed-off-by: Theo Truong <[email protected]>

* # Sentence casing

Signed-off-by: Theo Truong <[email protected]>

* # vale:reviewdog

Signed-off-by: Theo Truong <[email protected]>

* # vale:reviewdog

Signed-off-by: Theo Truong <[email protected]>

* # vale:reviewdog

Signed-off-by: Theo Truong <[email protected]>

* # Correction on cron job run time.

Signed-off-by: Theo Truong <[email protected]>

* Apply suggestions from code review

Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: Theo N. Truong <[email protected]>

* # More clarity in method documentation

Signed-off-by: Theo Truong <[email protected]>

* Update DEVELOPER_GUIDE.md

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Theo Truong <[email protected]>
Signed-off-by: Theo N. Truong <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants