Add offline documentation #737
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Offline documentation is provided in both PDF and HTML form. As the extension used to build the PDF may come with dependency issues, it is commented out in `requirements.txt`. Both offline versions will be created manually as part of the release process by a technical writer and added to GitHub. Change to the glossary page fixes an issue with linking within the PDF.the TOC on the title page shows 2 levels, which makes the PDF simpler to navigate. QA: Checked that "Offline Version" link in footer would link to `/releases/` if dev version of docs, otherwise to the release version. Checked rendered output in browser. Ran linkcheck. This commit addresses FFTK-1785 Signed-off-by: Katrina Prosise <[email protected]>
|
Docs for 123189a are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2728/docs/artifacts/html/index.html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Offline documentation is provided in both PDF and HTML form. As the extension used to build the PDF may come with dependency issues, it is commented out in
requirements.txt. Both offline versions will be created manually as part of the release process by a technical writer and added to GitHub.Change to the glossary page fixes an issue with linking within the PDF.the TOC on the title page shows 2 levels, which makes the PDF simpler to navigate.
QA: Checked that "Offline Version" link in footer would link to
/releases/if dev version of docs, otherwise to the release version. Checked rendered output in browser. Ran linkcheck.This commit addresses FFTK-1785
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
Why merge this PR? What does it solve?
Checklist
make linkcheck.-s, --signoff).-S, --gpg-sign).