search

idaholab / blackbear

BlackBear is a MOOSE-based code for simulating degradation processes in concrete and other structural materials.
GNU Lesser General Public License v2.1
17 stars 42 forks source link

Adjust BlackBear SQA documents for custom entries #297

Closed cticenhour closed 1 year ago

cticenhour commented 2 years ago

This PR adds some customization examples to the SRS and SDD, such that they can be further modified. Pending adjustments to the application SQA templates for these documents as well as the RTM will highlight gaps in template entries that need to be filled, as well as a formal template suggestion of how to fill them. In practice, developers should also look at the framework versions of these documents as they develop their own to ensure similar content is present in both.

The CCI was also pointed to the wrong template, and this was corrected.

@bwspenc I would consider this PR a work in progress for now, so I am making it a draft. Would like to get the MOOSE changes in so that you can see the information boxes that should appear for gaps in the documents.

Refs #127

cticenhour commented 2 years ago

Related MOOSE PR: idaholab/moose#20971

moosebuild commented 2 years ago

Job Test on 5a8954f wanted to post the following:

View the site here

This comment will be updated on new commits.

moosebuild commented 2 years ago

Job Coverage on 5a8954f wanted to post the following:

Coverage

Coverage did not change

Full coverage report

This comment will be updated on new commits.

cticenhour commented 2 years ago

@bwspenc Pending testing, this PR should be ready to merge for your team to start filling the SQA documents in. I filled a couple locations in the SDD and SRS with either a better description or sample entry to give something to go off of - otherwise the main framework versions of these documents are a good place to start if the section descriptions given in the red boxes are not adequate.

As always, feel free to reach out if you need anything regarding getting the rest of the SQA work done for this task.

cticenhour commented 1 year ago

These changes were merged in as of 38f43bf, with merge commit information provided via GitHub logging the PR number associated with the change. GitHub erroneously left this PR open, but it can be closed.