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

Add offline documentation via pdf #731

Closed
wants to merge 2 commits into from
Closed

Conversation

kprosise
Copy link
Contributor

@kprosise kprosise commented Jul 30, 2024

Added basic configuration and support for generating PDF version of the documentation. This is done with simplepdf.

Also added to the jobserv.yml file for PR requests, which will need to be tested.

QA steps: built PDF and HTML. Checked that HTML would build with missing PDF. Checked that PDf download worked from both top index page and any other page. Checked that PDF links worked and output was readable. Note that simplepdf will report errors due to links in sidebar.These can be ignored.

This commit addresses task FFTK-1795
This commit applies to FFPK-93
This commit applies to FS-1826

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

PDF download in Footer

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Will need to make sure that PR builds; there are a couple potential issues.

  • May require libraries to be installed in order to build PDFs
  • Increases build time of documentation substantially

@kprosise kprosise requested review from angolini, mike-scott, vanmaegima and a team July 30, 2024 12:22
@kprosise
Copy link
Contributor Author

Looking into build failure now, and indeed, there were issues installing some of the new dependencies.

@doanac
Copy link
Member

doanac commented Jul 30, 2024

@doanac
Copy link
Member

doanac commented Jul 30, 2024

@kprosise kprosise marked this pull request as draft July 30, 2024 15:58
@kprosise
Copy link
Contributor Author

Builds...and is available, however page numbering and links to pages from index are off

@doanac
Copy link
Member

doanac commented Aug 7, 2024

@kprosise kprosise marked this pull request as ready for review August 9, 2024 10:16
@doanac
Copy link
Member

doanac commented Aug 9, 2024

@kprosise
Copy link
Contributor Author

kprosise commented Aug 9, 2024

The note added to the main index mentions the HTML release as the ideal way to view the docs, and mentions the pdf link in the footer. PDF was not linked in the admonition on purpose; if a customer still wishes to download it they may, but a PDF will never be the optimized way of reading the docs.

Copy link
Collaborator

@angolini angolini left a comment

Choose a reason for hiding this comment

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

I approve the PR as it is today! But I want to make some comments just in case.

  • I like the home page with maxdepth=2 in the HTML
  • Is there a reason why the pdf version is not available along with the HTML under the github release tab? If in the future, if we decide to also provide pdf in the release tab, the tip will be outdated. I would not mention "HTML version" in the tip, would say something as "offline version available" or something.
  • for me, it looks like "Note that some elements in the PDF, such as board flashing sections, do not render correctly." is something to be added to the Release Notes. I don't think it hurts to keep this in the first page, however, I will never trust I will remember to remove it in case the pdf is fixed in the future.
  • this whole "offline version" for the docs is something to go to the RN as well

@angolini
Copy link
Collaborator

angolini commented Aug 9, 2024

oh! I just remember I don't know if next doc release will be decoupled from lmp release having a different RN

Added basic configuration and support for generating PDF version of the
documentation. This is done with simplepdf.

Also added to the jobserv.yml file for PR requests, which will need to be
tested.

QA steps: built PDF and HTML. Checked that HTML would build with missing
PDF. Checked that PDf download worked from both top index page and any
other page. Checked that PDF links worked and output was readable.
Note that simplepdf will report errors due to links in sidebar.These can
be ignored.

This commit addresses task FFTK-1795
This commit applies to FFPK-93
This commit applies to FS-1826

Signed-off-by: Katrina Prosise <[email protected]>
@doanac
Copy link
Member

doanac commented Aug 14, 2024

@doanac
Copy link
Member

doanac commented Aug 14, 2024

@kprosise
Copy link
Contributor Author

GitHub guided merge conflict resolution via the web-editor didn't help much. It will be quicker and likely simpler to close this PR and open a new one, with some additional changes.

@kprosise kprosise closed this Aug 14, 2024
@kprosise kprosise deleted the pdf-gen branch August 15, 2024 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants