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.

Sign up for GitHub

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

Jump to bottom

DM-10636: Update installation docs for v14 (in progress) #54

Merged
merged 14 commits into from
Sep 15, 2017
Merged

DM-10636: Update installation docs for v14 (in progress) #54

merged 14 commits into from
Sep 15, 2017

Commits on Sep 15, 2017

  1. Reorganize homepage Install/Project info sections 

    - Move links downwards to not distract from installation docs.
- Separate "Installation" from "Project info" sections so that release
  notes and such don't distract from how-to pages for installing the
  stack.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    d02d49b View commit details
    Browse the repository at this point in the history

  2. Refactor prerequisite docs from newinstall docs 

    This makes it easier to document pre-requisites from either the lsstsw
or newinstall installation methods. Overall it makes the newinstall docs
easier to follow, as well, making it possible to use the newinstall docs
from a getting started context.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    7e50c68 View commit details
    Browse the repository at this point in the history

  3. Remove conda installation docs 

    A conda distribution is no longer provided with v14 of the stack.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    4ec8167 View commit details
    Browse the repository at this point in the history

  4. Overhaul newinstall docs: simplify + v14 binaries 

    - Simplify the newinstall.sh installation instructions to minimize
  commentary in the how-to steps. The idea is that this commentary and
  alternative installation strategies will be linked to an "advanced
  topics" section.

- Update the newinstall.sh command so it uses binaries (-t). Also use
  (-c) to continue a failed build because Josh Hoblitt recommends it.

- Point to the 14.0 release.

- Adds sections on binaries, ABI compatibility, tag format, the
  Miniconda Python, and background/reference on newinstall.sh itself.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    dcb0d8d View commit details
    Browse the repository at this point in the history

  5. Add page on top-level packages 

    This explains and mentions that lsst_apps and lsst_distrib both exist.
The page will get better when we have packages in the pipelines.lsst.io
docs and they automatically report their package dependencies.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    d4617c9 View commit details
    Browse the repository at this point in the history

  6. Add topic on setting up the stack 

    This is a standalone from the installation instructions to make it
easier to understanding what steps need to be done in in each new shell,
compared to a new installation.

Also lets us add additional background on `setup` itself.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    0708d98 View commit details
    Browse the repository at this point in the history

  7. Add new topic on running from Docker 

    This covers a basic quick start and how to find tags on Docker Hub.
Future commits can add details on attaching volumes, developing against
a containerized stack, and creating new images with Dockerfiles.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    d3ef922 View commit details
    Browse the repository at this point in the history

  8. Update demo for v14.0 release

    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    5305126 View commit details
    Browse the repository at this point in the history

  9. Demo page edits 

    - Switch to sentence case headers.
- Improve some of the technical writing style.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    2a28db0 View commit details
    Browse the repository at this point in the history

  10. Bump CURRENT_RELEASE to 14.0

    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    48e2d7a View commit details
    Browse the repository at this point in the history

  11. Update lsstsw-based install docs 

    - Update for 14.0

- Move advanced how-to and reference material from the basic
  installation steps.

- Add overviews of deploy and rebuild, along with command references.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    8020236 View commit details
    Browse the repository at this point in the history

  12. Move package development docs from lsstsw 

    The same docs should apply to all base installations, where it's
newinstall, lsstsw, or Docker. This commit moves the original content to
an orphan page to give us time to make that change.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    9c2998c View commit details
    Browse the repository at this point in the history

  13. Make homepage the curated install entrypoint 

    Before, both the homepage and install/index.rst served as entrypoints
for the installation docs.

Now I'm making the homepage the curated documentation entrypoint, but
install/index.rst has the toctree so that a user landing at
https://pipelines.lsst.io/install can still find all the topics.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    14e0cc0 View commit details
    Browse the repository at this point in the history

  14. Change prereq messaging about Miniconda 

    This wording encourages users to use the provided Python instead of
using their own.
    @jonathansick
    jonathansick committed Sep 15, 2017
    Configuration menu
    Copy the full SHA
    3821883 View commit details
    Browse the repository at this point in the history