-
Notifications
You must be signed in to change notification settings - Fork 632
[DOC] Downloadable PDF Developer Guides #11601
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
base: main
Are you sure you want to change the base?
Conversation
|
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. |
c7020bb to
0cb39f5
Compare
Signed-off-by: Arya Soni <aryasoni98@gmail.com>
Signed-off-by: Arya Soni <aryasoni98@gmail.com>
Signed-off-by: Arya Soni <aryasoni98@gmail.com>
Signed-off-by: Arya Soni <aryasoni98@gmail.com>
ddcf95b to
c4dcdf2
Compare
|
@peterzhuamazon Could you review this PR? |
|
Thanks, @aryasoni98 That said, the PR does appear to miss the objective of #11192 , which is to create a single documentation PDF as cited in the AWS example. Your solution would be akin to printing each page as a PDF. Not sure if that is sufficient for what @sarahgancisonos is looking for. I'll leave time for her to comment as well. |
Description
This PR implements downloadable PDF generation for OpenSearch developer guides and documentation collections. The feature enables users to download complete documentation guides as PDF files, providing:
Implementation Details:
_pdf_generator/pdf_generator.rb) that generates PDFs during the build process_pdf_generator/folder as requestedgroverRuby gem (Puppeteer-based) for high-quality PDF generation from HTML_site/pdfs/directoryhttps://docs.opensearch.org/pdfs/{filename}.pdfwhen deployed_config.ymlto specify which collections/guides should generate PDFsFiles Added:
_pdf_generator/pdf_generator.rb- Main plugin implementation_pdf_generator/README.md- Documentation for the PDF generator_plugins/pdf_generator_loader.rb- Minimal loader to ensure Jekyll loads the pluginFiles Modified:
Gemfile- Addedgrovergem dependency_config.yml- Added PDF generator configuration section and plugin registrationIssues Resolved
Closes #11192
Version
all
Frontend features
N/A - This is a backend build-time feature that generates downloadable PDF files.
Checklist