Merge pull request #26015 from cticenhour/sqa-grab-bag

Various documentation tweaks

framework/doc/content/templates/sqa/app_rtm.md.template

@@ -32,7 +32,7 @@ git submodule foreach 'git clean -xfd'
 ```
 
 All tests must pass in accordance with the type of test being performed. This list
-can be found in the [Software Test Plan](sqa/{{stp_filename}}).
+can be found in the [Software Test Plan](sqa/{{category}}_stp.md).
 !template-end!
 
 !template! item key=functional-requirements

framework/doc/content/templates/sqa/module_rtm.md.template

@@ -33,7 +33,7 @@ git submodule foreach 'git clean -xfd'
 ```
 
 All tests must pass in accordance with the type of test being performed. This list
-can be found in the [Software Test Plan](sqa/{{stp_filename}}).
+can be found in the [Software Test Plan](sqa/{{category}}_stp.md).
 !template-end!
 
 !template! item key=functional-requirements

modules/contact/doc/content/modules/contact/sqa/contact_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=contact module=Contact stp_filename=contact_stp.md
+!template load file=sqa/module_rtm.md.template category=contact module=Contact
 
 !template! item key=system-purpose
 !include contact_srs.md start=system-purpose-begin end=system-purpose-finish

modules/doc/content/sqa/moose_far.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_far.md.template app=MOOSE category=_empty_
+!template load file=sqa/app_far.md.template app=MOOSE category=moose
 
 !template item key=introduction
 MOOSE itself is comprised of the framework and a set of physics modules. As such, the [!ac](FAR)

modules/doc/content/sqa/moose_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_rtm.md.template app=MOOSE category=_empty_ stp_filename=moose_stp.md
+!template load file=sqa/app_rtm.md.template app=MOOSE category=moose
 
 !template item key=system-purpose
 !include system_purpose.md

modules/doc/content/sqa/moose_sdd.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_sdd.md.template app=MOOSE category=_empty_
+!template load file=sqa/app_sdd.md.template app=MOOSE category=moose
 
 !template item key=introduction
 !include framework_sdd.md start=introduction-begin end=introduction-finish

modules/doc/content/sqa/moose_sll.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_sll.md.template app=[!ac](MOOSE) category=_empty_
+!template load file=sqa/app_sll.md.template app=[!ac](MOOSE) category=moose
 
 !template item key=dependencies-intro
 The [!ac](SLL) for {{app}} as whole, including the framework, modules, and supporting infrastructure

modules/doc/content/sqa/moose_srs.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_srs.md.template app=MOOSE category=_empty_
+!template load file=sqa/app_srs.md.template app=MOOSE category=moose
 
 !template item key=system-purpose
 !include system_purpose.md

modules/doc/content/sqa/moose_stp.md

@@ -1 +1 @@
-!template load file=sqa/app_stp.md.template app=MOOSE category=_empty_
+!template load file=sqa/app_stp.md.template app=MOOSE category=moose

modules/doc/content/sqa/moose_vrr.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_vvr.md.template app=MOOSE category=_empty_
+!template load file=sqa/app_vvr.md.template app=MOOSE category=moose
 
 !template item key=introduction
 MOOSE itself is comprised of the framework and a set of physics modules. As such, the [!ac](VVR)

modules/doc/content/sqa/moose_vvr.md

@@ -1,4 +1,4 @@
-!template load file=sqa/app_vvr.md.template app=MOOSE category=_empty_
+!template load file=sqa/app_vvr.md.template app=MOOSE category=moose
 
 !template item key=introduction
 MOOSE itself is comprised of the framework and a set of physics modules. As such, the [!ac](VVR)

modules/doc/duplicate_bibs.yml

@@ -1,3 +1,4 @@
 - kim_phase-field_1999 # referenced in both Tensor Mechanics and Phase Field
 - hales15homogenization # referenced in both Tensor Mechanics and Heat Conduction
 - greenshields2010implementation # referenced in both Navier Stokes and Framework
+- jasak1996error # referenced in both Navier Stokes and Darcy Flow tutorial

modules/electromagnetics/doc/content/modules/electromagnetics/sqa/electromagnetics_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template module=Electromagnetics category=electromagnetics stp_filename=electromagnetics_stp.md
+!template load file=sqa/module_rtm.md.template module=Electromagnetics category=electromagnetics
 
 !template! item key=system-purpose
 !include electromagnetics_srs.md start=system-purpose-begin end=system-purpose-finish

modules/fluid_properties/doc/content/modules/fluid_properties/sqa/fluid_properties_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=fluid_properties module=Fluid Properties stp_filename=fluid_properties_stp.md
+!template load file=sqa/module_rtm.md.template category=fluid_properties module=Fluid Properties
 
 !template! item key=system-purpose
 !include fluid_properties_srs.md start=system-purpose-begin end=system-purpose-finish

modules/fsi/doc/content/modules/fsi/sqa/fsi_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=fsi module=Fluid Structure Interaction stp_filename=fsi_stp.md
+!template load file=sqa/module_rtm.md.template category=fsi module=Fluid Structure Interaction
 
 !template! item key=system-purpose
 !include fsi_srs.md start=system-purpose-begin end=system-purpose-finish

modules/heat_transfer/doc/content/modules/heat_transfer/sqa/heat_transfer_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=heat_transfer module=Heat Transfer stp_filename=heat_transfer_stp.md
+!template load file=sqa/module_rtm.md.template category=heat_transfer module=Heat Transfer
 
 !template! item key=system-purpose
 !include heat_transfer_srs.md start=system-purpose-begin end=system-purpose-finish

modules/level_set/doc/content/modules/level_set/sqa/level_set_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=level_set module=Level Set stp_filename=level_set_stp.md
+!template load file=sqa/module_rtm.md.template category=level_set module=Level Set
 
 !template! item key=system-purpose
 !include level_set_srs.md start=system-purpose-begin end=system-purpose-finish

modules/misc/doc/content/modules/misc/sqa/misc_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=misc module=Misc stp_filename=misc_stp.md
+!template load file=sqa/module_rtm.md.template category=misc module=Misc
 
 !template! item key=system-purpose
 !include misc_srs.md start=system-purpose-begin end=system-purpose-finish

modules/navier_stokes/doc/content/modules/navier_stokes/sqa/navier_stokes_rtm.md

@@ -1,9 +1,9 @@
-!template load file=sqa/module_rtm.md.template category=navier_stokes module=Navier Stokes stp_filename=navier_stokes_stp.md
+!template load file=sqa/module_rtm.md.template category=navier_stokes module=Navier Stokes
 
 !template! item key=system-purpose
 !include navier_stokes_srs.md start=system-purpose-begin end=system-purpose-finish
 !template-end!
 
 !template! item key=system-scope
 !include navier_stokes_srs.md start=system-scope-begin end=system-scope-finish
-!template-end!
+!template-end!

modules/optimization/doc/content/modules/optimization/sqa/optimization_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template module=Optimization category=optimization stp_filename=optimization_stp.md
+!template load file=sqa/module_rtm.md.template module=Optimization category=optimization
 
 !template item key=system-purpose
 !include optimization_srs.md start=system-purpose-begin end=system-purpose-finish

modules/phase_field/doc/content/modules/phase_field/sqa/phase_field_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=phase_field module=Phase Field stp_filename=phase_field_stp.md
+!template load file=sqa/module_rtm.md.template category=phase_field module=Phase Field
 
 !template! item key=system-purpose
 !include phase_field_srs.md start=system-purpose-begin end=system-purpose-finish

modules/porous_flow/doc/content/modules/porous_flow/sqa/porous_flow_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=porous_flow module=Porous Flow stp_filename=porous_flow_stp.md
+!template load file=sqa/module_rtm.md.template category=porous_flow module=Porous Flow
 
 !template! item key=system-purpose
 !include porous_flow_srs.md start=system-purpose-begin end=system-purpose-finish

modules/ray_tracing/doc/content/sqa/ray_tracing_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template module=Ray Tracing category=ray_tracing stp_filename=ray_tracing_stp.md
+!template load file=sqa/module_rtm.md.template module=Ray Tracing category=ray_tracing
 
 !template! item key=system-purpose
 !include ray_tracing_srs.md start=system-purpose-begin end=system-purpose-finish

modules/reactor/doc/content/modules/reactor/sqa/reactor_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=reactor module=Reactor stp_filename=reactor_stp.md
+!template load file=sqa/module_rtm.md.template category=reactor module=Reactor
 
 !template! item key=system-purpose
 !include reactor_srs.md start=system-purpose-begin end=system-purpose-finish

modules/scalar_transport/doc/content/sqa/scalar_transport_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=scalar_transport module=Scalar Transport stp_filename=scalar_transport_stp.md
+!template load file=sqa/module_rtm.md.template category=scalar_transport module=Scalar Transport
 
 !template! item key=system-purpose
 !include scalar_transport_srs.md start=system-purpose-begin end=system-purpose-finish

modules/stochastic_tools/doc/content/modules/stochastic_tools/sqa/stochastic_tools_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=stochastic_tools module=Stochastic Tools stp_filename=stochastic_tools_stp.md
+!template load file=sqa/module_rtm.md.template category=stochastic_tools module=Stochastic Tools
 
 !template item key=system-purpose
 !include stochastic_tools_srs.md start=system-purpose-begin end=system-purpose-finish

modules/tensor_mechanics/doc/content/bib/tensor_mechanics.bib

@@ -940,17 +940,6 @@ @article{borden2016phase
   publisher = {Elsevier}
 }
 
-@article{walters_interaction_2005,
-  author  = {Walters, Matthew C. and Paulino, Glaucio H. and Dodds, Robert H.},
-  journal = {Engineering Fracture Mechanics},
-  month   = {July},
-  number  = {11},
-  pages   = {1635--1663},
-  title   = {Interaction integral procedures for 3-{D} curved cracks including surface tractions},
-  volume  = {72},
-  year    = {2005}
-}
-
 @article{Jeong2004functionallygraded,
     author = {Kim, Jeong-Ho and Paulino, Glaucio H.},
     title = {Consistent Formulations of the Interaction Integral Method for Fracture of Functionally Graded Materials},

modules/tensor_mechanics/doc/content/modules/tensor_mechanics/sqa/tensor_mechanics_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=tensor_mechanics module=Tensor Mechanics stp_filename=tensor_mechanics_stp.md
+!template load file=sqa/module_rtm.md.template category=tensor_mechanics module=Tensor Mechanics
 
 !template! item key=system-purpose
 !include tensor_mechanics_srs.md start=system-purpose-begin end=system-purpose-finish

modules/thermal_hydraulics/doc/content/modules/thermal_hydraulics/sqa/thermal_hydraulics_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template module=Thermal Hydraulics category=thermal_hydraulics stp_filename=thermal_hydraulics_stp.md
+!template load file=sqa/module_rtm.md.template module=Thermal Hydraulics category=thermal_hydraulics
 
 !template! item key=system-purpose
 !include thermal_hydraulics_srs.md start=system-purpose-begin end=system-purpose-finish

modules/xfem/doc/content/modules/xfem/sqa/xfem_rtm.md

@@ -1,4 +1,4 @@
-!template load file=sqa/module_rtm.md.template category=xfem module=XFEM stp_filename=xfem_stp.md
+!template load file=sqa/module_rtm.md.template category=xfem module=XFEM
 
 !template! item key=system-purpose
 !include xfem_srs.md start=system-purpose-begin end=system-purpose-finish

python/MooseDocs/extensions/gallery.py

@@ -223,7 +223,7 @@ def createMaterialize(self, parent, token, page):
         for child in token.children:
             if child.name != 'Card':
                 msg = "The 'gallery' command requires that all content be within cards (i.e., " \
-                      "created with the 'card' command. However, one of the children of the " \
+                      "created with the 'card' command). However, one of the children of the " \
                       "gallery is a '%s' token."
                 LOG.error(msg, child.name)
 

python/MooseDocs/extensions/sqa.py

@@ -319,7 +319,7 @@ def defaultSettings():
     def createToken(self, parent, info, page, settings):
         category = settings['category']
         collections = settings['collections']
-        if category == '_empty_':
+        if category == 'moose':
             return parent
 
         group_map = self.extension.get('requirement-groups', dict())
@@ -444,7 +444,7 @@ def defaultSettings():
 
     def createToken(self, parent, info, page, settings):
         category = settings['category']
-        if category == '_empty_':
+        if category == 'moose':
             return parent
 
         design = collections.defaultdict(list)
@@ -487,7 +487,7 @@ def defaultSettings():
 
     def createToken(self, parent, info, page, settings):
         category = settings['category']
-        if category == '_empty_':
+        if category == 'moose':
             return parent
 
         subcommand = info['subcommand']
@@ -515,7 +515,7 @@ def defaultSettings():
     def createToken(self, parent, info, page, settings):
         suffix = settings['suffix']
         category = settings['category'] or None
-        if category == '_empty_':
+        if category == 'moose':
             depends = self.extension.get('categories').keys()
         else:
             depends = self.extension.dependencies(category) or \

scripts/stork.sh

@@ -124,25 +124,42 @@ if [[ "$kind" == "app" ]]; then
     cp $MOOSE_DIR/.clang-format $dir/
     cp $MOOSE_DIR/.gitignore $dir/
 
+    # add application-specific generated resource file to end of gitignore file
+    echo "$dstnamelow.yaml" >> $dir/.gitignore
+
     dir="$PWD/$dir"
     (cd $dir && git init && git add * .clang-format .gitignore && git commit -m "Initial files" && git branch -m main)
 
     echo "MOOSE app created in '$dir'"
     echo ""
-    echo "To store your changes on github:"
-    echo "    1. log in to your account"
-    echo "    2. Create a new repository named $dstnamelow"
-    echo "    3. in this terminal run the following commands:"
+    echo "To store your changes on GitHub:"
+    echo "    1. Log in to your GitHub account"
+    echo "    2. Create a new repository named '$dstnamelow'"
+    echo "    3. In this terminal window, run the following commands:"
     echo "         cd $dir"
     echo "         git remote add origin https://github.com/YourGitHubUserName/$dstnamelow"
-    echo '         git commit -m "initial commit"'
+    echo '         git commit -m "Initial code commit"'
     echo "         git push -u origin main"
     echo ""
     echo "To automatically enforce MOOSE C++ code style in your commits, run:"
     echo ""
     echo "    cd $dir"
     echo "    ./scripts/install-format-hook.sh"
     echo ""
+    echo "To enable software quality assurance (SQA) documentation using MooseDocs, perform the"
+    echo "following steps after adding your git repository remote:"
+    echo ""
+    echo "    1. Navigate to $dir/doc"
+    echo "    2. Run './moosedocs.py init sqa --app '$dstnamespace' --category $dstnamelow'"
+    echo "    3. Commit the initial SQA changes using the following commands:"
+    echo "         git add $dir/doc"
+    echo '         git commit -m "Initial SQA changes"'
+    echo "         git push origin main"
+    echo "    4. Add new SQA content to the forms in $dir/doc/content/sqa"
+    echo ""
+    echo "For general assistance in MOOSE-based application SQA, please contact the MOOSE"
+    echo "framework development team. For further info on the MooseDocs code documentation"
+    echo "system, please visit https://mooseframework.inl.gov."
 fi
 
 if [[ "$kind" == "module" ]]; then

stork/doc/config.yml.app

@@ -8,10 +8,8 @@ Content:
             - css/*
             - contrib/**
             - media/**
-
 Renderer:
     type: MooseDocs.base.MaterializeRenderer
-
 Extensions:
     MooseDocs.extensions.navigation:
         name: Stork