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 support (#1779) #1802

Merged
merged 2 commits into from
Oct 2, 2019
Merged

Add offline support (#1779) #1802

merged 2 commits into from
Oct 2, 2019

Conversation

echlebek
Copy link
Contributor

@echlebek echlebek commented Oct 1, 2019

Continuation of #1779 which was mistakenly merged to master. Please continue development from this branch, or create another PR from the original.

* Add initial offline layouts.

* Add basic Table of Contents to offline templates

* Add instructions for previewing offline docs

* Add "offline" key to front matter

Enables pages to be excluded from offline docs

* Add documentation for offline front matter

* Update offline style build process.

* Update offline styles

* Add offline build script

* Update offline styles

* Fix language-toggle display for offline docs

* Fix tables in offline docs
@hillaryfraley
Copy link
Contributor

hillaryfraley commented Oct 1, 2019

Ryan's instructions from the original PR (#1779):

Description

Adds layouts, styles, and build processes for generating offline documentation (e.g. PDFs). For now, PDFs should be generated manually via Adobe Acrobat.

Resolves #1647

Motivation and Context

Customers would like to access Sensu docs offline and on e-reader devices.

Review Instructions

  1. Run a local hugo server with offline layouts

    yarn run server --layoutDir=offline
    
  2. Navigate to http://localhost:1313/ and select your product/version of choice. Note the URL of this resource.

  3. Open Acrobat and File → Create → PDF from Web Page

    image image

@hillaryfraley
Copy link
Contributor

per @cwjohnston -- merge this PR; copy "must fix" items to new issue to discuss w/Ryan.

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