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

[HUGO] Export an article to a PDF #33

Closed
jwflory opened this issue May 11, 2021 · 0 comments · Fixed by #57
Closed

[HUGO] Export an article to a PDF #33

jwflory opened this issue May 11, 2021 · 0 comments · Fixed by #57
Assignees
Labels
?: question Further information is requested T: new change Adds new capabilities or functionality

Comments

@jwflory
Copy link
Member

jwflory commented May 11, 2021

Summary

Add a one-click export option/button to export an article to a downloadable PDF document.

Background

Is your feature request related to a problem? Please describe:

Often with the Innovation Fund, we distribute multiple documents, agreements, and other resources at once when we bring in a new Innovation Fund start-up. Usually this is via Office 365 (Word) documents and PDFs. While it makes sense in this context to distribute files like .docx and .pdf, this method is also difficult to manage versioning and reliably maintaining a parent copy over time.

Describe the solution you'd like:

Some documents, which can be public, could be stored as editable source text in this repository. In the event where we create on-boarding packages tailored to a specific grantee, a one-click export of an article to a PDF enables parent copies to be maintained in GitHub, while also reliably fitting into this existing manual workflow.

Describe alternatives you've considered:

Not sure. This feature request requires more research on implementation before jumping in and writing code.

Details

The PDF export needs to be as simple as possible. The PDF metadata should also be derived from the document metadata defined in the article front matter. This needs research into the cleanest implementation possible. Ideally, it fits into the Hugo theme.

If it does not fit into the Hugo theme, we could explore some hacky ways of doing this in the Circle CI pipeline with pandoc, but that is a last-resort choice. It has messy design implications as a long-term feature, but addresses an immediate need.

Outcome

  • New workflow: Better document versioning and easier to keep parent copies of important documents distributed on a recurring basis
  • Old workflow: Distributing files at time of Innovation Fund on-boarding is still possible, fitting in with other documents we distribute unrelated to Open Source
@jwflory jwflory added ?: question Further information is requested T: new change Adds new capabilities or functionality labels May 11, 2021
@Idadelveloper Idadelveloper self-assigned this Aug 12, 2021
jwflory added a commit that referenced this issue Aug 19, 2021
This commit updates the theme submodule to include an option to download
any page from the Open Source Inventory as a PDF. This was added by
@Idadelveloper in unicef/inventory-hugo-theme#9.

Furthermore, we plan to upstream this patch in the near future per the
discussion in gethugothemes/dot-hugo#167. Therefore,
this commit contributes to #33 but will not close the issue. We will
close #33 once the patch is merged upstream.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
jwflory added a commit that referenced this issue Aug 19, 2021
This commit updates the theme submodule to include an option to download
any page from the Open Source Inventory as a PDF. This was added by
@Idadelveloper in unicef/inventory-hugo-theme#9.

Furthermore, we plan to upstream this patch in the near future per the
discussion in gethugothemes/dot-hugo#167. Therefore,
this commit contributes to #33 but will not close the issue. We will
close #33 once the patch is merged upstream.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <jflory@unicef.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
?: question Further information is requested T: new change Adds new capabilities or functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants