Skip to content

Commit

Permalink
more docs updates (#646)
Browse files Browse the repository at this point in the history
  • Loading branch information
cyrush authored Nov 3, 2020
1 parent 3837964 commit dcab780
Show file tree
Hide file tree
Showing 19 changed files with 26 additions and 26 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Conduit
Conduit is an open source project from Lawrence Livermore National Laboratory that provides an intuitive model for describing hierarchical scientific data in C++, C, Fortran, and Python. It is used for data coupling between packages in-core, serialization, and I/O tasks.

[![Travis CI Build Status](https://travis-ci.org/LLNL/conduit.png)](https://travis-ci.org/LLNL/conduit)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/llnl/conduit?branch=master&svg=true)](https://ci.appveyor.com/project/cyrush/conduit)
[![Coverage Status](https://coveralls.io/repos/github/LLNL/conduit/badge.svg?branch=master)](https://coveralls.io/github/LLNL/conduit?branch=master)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/llnl/conduit?branch=develop&svg=true)](https://ci.appveyor.com/project/cyrush/conduit)
[![Coverage Status](https://coveralls.io/repos/github/LLNL/conduit/badge.svg?branch=develop)](https://coveralls.io/github/LLNL/conduit?branch=develop)
[![Static Analysis Status](https://scan.coverity.com/projects/8426/badge.svg?flat=1)](https://scan.coverity.com/projects/llnl-conduit)

Documentation
Expand Down
2 changes: 1 addition & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ trigger: none
pr:
branches:
include:
- master
- develop

# fast fail sanity checks
stages:
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/alcf/cooley/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ packages:
tbb: [intel-tbb]
jpeg: [libjpeg-turbo, libjpeg]
conduit:
version: [master]
version: [develop]
# Cooley Cuda
cuda:
paths:
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/alcf/theta/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ packages:
[email protected]: cray-mpich/7.6.3
buildable: False
conduit:
version: [master]
version: [develop]
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ packages:
tbb: [intel-tbb]
jpeg: [libjpeg-turbo, libjpeg]
conduit:
version: [master]
version: [develop]
# LLNL blueos CUDA
cuda:
paths:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ packages:
tbb: [intel-tbb]
jpeg: [libjpeg-turbo, libjpeg]
conduit:
version: [master]
version: [develop]
python:
variants: ~dbm
cmake:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ packages:
tbb: [intel-tbb]
jpeg: [libjpeg-turbo, libjpeg]
conduit:
version: [master]
version: [develop]
# LLNL chaos5 CUDA
cuda:
paths:
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/ci/ubuntu_16/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ packages:
paths:
tar: /usr
conduit:
version: [master]
version: [develop]
# python 2 constraints
py-sphinx:
version: [1.8.4]
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/ci/ubuntu_18/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ packages:
paths:
tar: /usr
conduit:
version: [master]
version: [develop]
# python 2 constraints
py-sphinx:
version: [1.8.4]
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/darwin/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ packages:
variants: ~openmp
# custom variants
conduit:
version: [master]
version: [develop]
python:
variants: +shared~dbm
# python 2 constraints
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/docker/ubuntu/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ packages:
paths:
tar: /usr
conduit:
version: [master]
version: [develop]
# python 2 constraints
py-sphinx:
version: [1.8.4]
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/nersc/cori/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ packages:
paths:
perl: /usr
conduit:
version: [master]
version: [develop]
cmake:
version: [3.9.6]
variants: ~ncurses~openssl
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/tacc/stampede2/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ packages:
modules:
intel-mkl: mkl
conduit:
version: [master]
version: [develop]
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ packages:
tbb: [intel-tbb]
jpeg: [libjpeg-turbo, libjpeg]
conduit:
version: [master]
version: [develop]
python:
variants: ~dbm
cmake:
Expand Down
2 changes: 1 addition & 1 deletion scripts/uberenv/spack_configs/travis/packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ packages:
paths:
tar: /usr
conduit:
version: [master]
version: [develop]
# python 2 constraints
py-sphinx:
version: [1.8.4]
Expand Down
6 changes: 3 additions & 3 deletions src/docs/sphinx/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ Default invocation on OSX:
--spack-config-dir scripts/uberenv/spack_configs/darwin/
The uberenv `--install` installs conduit\@master (not just the development dependencies):
The uberenv `--install` installs conduit\@develop (not just the development dependencies):

.. code:: bash
Expand Down Expand Up @@ -315,11 +315,11 @@ To install the latest released version of Conduit with all options (and also bui
spack install conduit
To build and install Conduit's github master branch run:
To build and install Conduit's github develop branch run:

.. code:: bash
spack install conduit@master
spack install conduit@develop
The Conduit Spack package provides several `variants <http://spack.readthedocs.io/en/latest/basic_usage.html#specs-dependencies>`_ that customize the options and dependencies used to build Conduit:
Expand Down
10 changes: 5 additions & 5 deletions src/docs/sphinx/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ We are using a **Github Flow** model, which is a simpler variant of the confusin

Here are the basics:

- Development is done on topic branches off the master.
- Development is done on topic branches off the develop.

- Merge to master is only done via a pull request.
- Merge to develop is only done via a pull request.

- The master should always compile and pass all tests.
- The develop should always compile and pass all tests.

- Releases are tagged off of master.
- Releases are tagged off of develop.

More details on GitHub Flow:

Expand All @@ -104,7 +104,7 @@ Here are some other rules to abide by:

- If you have write permissions for the Conduit repo, you *can* merge your own pull requests.

- After completing all intended work on branch, please delete the remote branch after merging to master. (Github has an option to do this after you merge a pull request.)
- After completing all intended work on branch, please delete the remote branch after merging to develop. (Github has an option to do this after you merge a pull request.)



Expand Down
2 changes: 1 addition & 1 deletion src/docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. # Project developers. See top-level LICENSE AND COPYRIGHT files for dates and
.. # other details. No copyright assignment is required to contribute to Conduit.
.. Conduit documentation master file, created by
.. Conduit documentation main file, created by
sphinx-quickstart on Thu Oct 16 11:23:46 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expand Down
2 changes: 1 addition & 1 deletion src/examples/docker/ubuntu/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ RUN apt-get update && apt-get install -y \
COPY conduit.docker.src.tar /
RUN tar -xf conduit.docker.src.tar

# if you would like to clone conduit master directly, you can use:
# if you would like to clone conduit directly, you can use:
#RUN git clone --depth 1 https://github.com/LLNL/conduit.git

# at some sites ssl certs are intercepted, which cases issues fetching
Expand Down

0 comments on commit dcab780

Please sign in to comment.