rse-ops / rse-ops.github.io

Resources and Practices for Open Source Software

RSE-ops Home

How does it work?

Policy

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.

Posts

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.

Organization

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

Development

Previewing the Site

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 install

And then (also in the top level directory of your forked repository) run

$ jekyll serve
# or
$ bundle exec jekyll serve

and 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.

Automation

News Updates

The workflow update-posts.yaml is run nightly to retrieve new posts, and push them to the site.

Coming Soon

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 :)

Thanks

This interface would not be possible without the following supporting projects!

• stately covered by an MIT LICENSE
• particles.js covered by an MIT LICENSE

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.

rse-ops.github.io's Issues

Add main site content

We can just reproduce content that is currently online - no new content!

• policy
• about
• links to resources

And ideally we can grab the same llnl.github.io news and plop it here!

Create page that showcases containers?

Or maybe it should be served from docker-images? Will think about it.

Design of rse-ops: docs vs. projects

@alecbcs had some good feedback that the portal (and then directing to /home) is kind of awkward, e.g., here: https://rse-ops.github.io/home/. I think I'd like to make it better - we want rse-ops to be a nice site! @davidbeckingsale and @alecbcs do you want to discuss what we can make better (design and organization wise) and I can start working on it?

From what Alec and I want to do with special projects, I think the things we should talk about are:

• what is documentation / resources for rse-ops vs projects
• there should be two spaces for that - likely our current docs page is okay for docs but projects doesn't really have a home.

Namely, projects for rse-ops are different than radiuss projects (one are scientific apps/libraries for the lab, and the latter are our special projects initiatives. I'm working on a nice portal for radiuss projects:

and I am hoping rse-ops can have something equivalently nice, at least when we have the projects! But I'm wondering if we make them too similar if it would be confusing? or good? What we don't do well now I think is the portal to rse-ops, and transitioning between the two interfaces via links.

Let me know your thoughts!

Add automatic site previews with circle