Skip to content

Publish Documentation to Github #86

@oubiwann

Description

@oubiwann

Features/Tasks:

  • Select new platform for static generation (part of epic 64)
    • Use the poise LFE library
  • Create a data structure that pairs site paths to arbitrary functions (where the functions are responsible for ultimately generating the content that will be available at the corresponding paths) - Define site data structure lfex/poise#1
  • Create a function that exports all the content defined in the data structure above to a given or configured directory - Create generate function lfex/poise#3
  • Support versioning of published docs (see Versioning Docs #68)
  • Add the capability of serving pages locally during development - Add code for serving local docs during development #94
  • Create site map for static file generation - Create site map for static file generation #87
  • Use new Github support for publishing out of a project's docs dir
    • Create docs dir
    • Delete most of the old docs make targets
    • Statically generate site to docs dir using poise
    • Update static generation to account for current version and previous versions
  • Restructure docs dir in preparation for release
    • Add old versions of the site (these are all tagged) - this will require running Jekyll locally for each of these to convert the Markdown source to HTML
      • v0.7
      • v0.8
      • v0.9
      • v0.10
      • Create a new tag for v1.2 (Aug 24, 2016) and then add the content
    • Generate the new/dev content in dev
    • Create explicit, step-by-step instructions for contributors to add new templates, pages, generated content, etc.
  • Perform clean-up tasks
    • Remove theme drop-down from top-nav
    • Update copyright years
    • Diff dev lfe.css with SASS version and update SASS version with latest changes
    • Visit all the pages in the v1.2 release and note any missing/incorrect bits
    • Make notes here for all the missing bits
    • Remove old dir
    • Review the contents of all the LFE modules and make sure everything's still useful
    • Update docs gen_server to run the latest code
    • Update the README to point to the updated gen_server API in docs
  • Run in production - once all the content is generated in docs locally, it's time to go live (since this won't actually change the current docs site; it will be the same)
    • Update the old index pages to include an "Update" link pointing to http://docs.lfe.io/dev for those interested in bleeding-edge docs - WONTDO - the drop-down docs version menu handles this use case better
    • Create new master branch in docs repo (it only has a gh-pages branch right now)
    • Merge all of docs3 repo into docs repo -- but DON'T PUSH!
    • Change all references of docs3.lfe.io to docs.lfe.io
    • Place deprecation notice on docs3 repo (we'll still want to keep it around, due to the tickets, etc. that exist in it)
    • Re-gen latest content (should be ready after merge; but it's a good test to run again)
    • Push new master branch to Github
    • Update the docs repo to use docs dir for publishing and not gh-pages branch (this is a Github "Settings" change)

Part of Milestone v3 #62

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions