Each policy point defined at the policy home is rendered from data files in _data/policy. Thus, if you want to tweak the policy points, you should edit the data file. If you want to add a new category under policy, you can add a page under docs/policy.
The posts are automatically updated on a nightly bases, retrieved from llnl.github.io. If you would like to add another source of news for your research software engineering community or software group, please open an issue.
The following organization is used:
- pages: holds top level pages under "Documentation" (which is also included there)
- docs: generally include subpages of top level documentation pages. For example, the policy.md file is found in pages, but the subpages for that are under docs/policy.
- _posts: where LLNL posts are automatically added. You can add new content here and it won't be erased.
- _includes and _data are standard to Jekyll. You can read more about Jekyll here
To preview the site locally, you'll need to install jekyll It's then typical to go to the root of the site and issue (just once):
$ bundle installAnd then (also in the top level directory of your forked repository) run
$ jekyll serve
# or
$ bundle exec jekyll serveand open your browser to http://localhost:4000.
If you are having trouble try rm -rf _site, followed by bundle update, then bundle exec jekyll serve.
For pull requests we use CircleCI to preview the site on any pull request. After it finishes building, make sure you are logged in and following the repository, and then click on the "Artifacts" tab. You can select the static file to open and preview in your browser.
The workflow update-posts.yaml is run nightly to retrieve new posts, and push them to the site.
We will soon be adding or working on:
- A RESTful API to retrieve policy rules
- A single page print view of all policies
- More that @vsoch hasn't properly formulated yet :)
This interface would not be possible without the following supporting projects!
- stately covered by an MIT LICENSE
- particles.js covered by an MIT LICENSE
Copyright (c) 2017-2021, Lawrence Livermore National Security, LLC. Produced at the Lawrence Livermore National Laboratory.
The RADIUSS documentation is licensed under the MIT license LICENSE.
Copyrights and patents in the RADIUSS project are retained by contributors. No copyright assignment is required to contribute to RADIUSS Docker.
This work was produced under the auspices of the U.S. Department of Energy by Lawrence Livermore National Laboratory under Contract DE-AC52-07NA27344.