Giter Club home page Giter Club logo

terrapower.github.io's Introduction

ARMI Ecosystem Documentation

This repository exists to support a GitHub Pages website for the documentation of all open-source TerraPower projects. For instance, at the time of this writing, this repo represents the projects:

  • armi
  • armicontrib-dif3d
  • dragon-plugin

The primary documentation pages will be for the bleeding-edge, latest-and-greatest version of each repository/project. But as important releases happen, we will also append the versioned, official releases of the documentation too. For instance:

Instructions for Archiving Documentation upon Release

The default, top-level documentation in this repo (for instance, the top-level /armi/ folder) is used for the most recent, up-to-date, bleeding-edge version of the software. But every time a major/minor release happes, our release process is to immediately archive off the documentation for that software.

The process to archive docs is easy.

Let's say the ARMI package has just released version 1.0.0. Hurray! After waiting a few minutes, the documentation for that version will be automatically deployed by a GitHub Action job here, to the top-level /armi/ folder. To archive the documentation for that release, simply copy/paste the entire documenation folder to: /releases/armi/v1.0.0/. Done!

For extra points, please add a link to your new documentation in the top-level index.html file.

terrapower.github.io's People

Contributors

albeanth avatar andfranklin avatar bsculac avatar jakehader avatar john-science avatar jyang-tp avatar kasticrunch avatar keckler avatar lmikeh avatar mgjarrett avatar ntouran avatar onufer avatar opotowsky avatar partofthething avatar sombrereau avatar tianjingwd avatar youngmit avatar zachmprince avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

terrapower.github.io's Issues

ARMI Installation Clarification.

The instructions for installation under the quick start guide includes the following command line snip-it.

$ git clone https://github.com/terrapower/armi
$ pip install -r requirements.txt
$ python setup.py install
$ armi

However, following these instructions explicitly will result in a file not found error when performing pip install -r requirements.txt since the requirements.txt is within the armi folder. This can be alleviated by instructing the user to cd into the armi folder before attempting to perform the pip install -r requirements.txt step.

This should also be clarified under the the installation chapter of the user guide.

We could use a good front page

The issue, as I see it, is that we have terrapower.github.io pointing to a 404 page, but there are three subpages where are valid:

  • terrapower.github.io/armi/
  • terrapower.github.io/armicontrib-dif3d/
  • terrapower.github.io/dragon-plugin/

So, we just need a front page. Simple.

I also think this is important as I would like to add "old versions of the docs" that we copy/paste over manually. Something like:

  • terrapower.github.io/releases/armi/v0.2.0/
  • terrapower.github.io/releases/dragon-plugin/v1.0.0/

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.