-
Notifications
You must be signed in to change notification settings - Fork 27
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
Conversation
Looking into build failure now, and indeed, there were issues installing some of the new dependencies. |
Docs for 3055c98 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2711/docs/artifacts/html/index.html |
Docs for b672e77 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2712/docs/artifacts/html/index.html |
Builds...and is available, however page numbering and links to pages from index are off |
Docs for f44a7e0 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2716/docs/artifacts/html/index.html |
Docs for 09a7400 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2718/docs/artifacts/html/index.html |
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. |
There was a problem hiding this 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
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]>
Docs for e64d238 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2726/docs/artifacts/html/index.html |
Docs for 65b243e are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2727/docs/artifacts/html/index.html |
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. |
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
Overview
PDF download in Footer
Checklist
make linkcheck
.-s, --signoff
).-S, --gpg-sign
).Comments
Will need to make sure that PR builds; there are a couple potential issues.