Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MALAMUTE SQA gaps #73

Open
24 of 31 tasks
cticenhour opened this issue May 15, 2023 · 0 comments
Open
24 of 31 tasks

MALAMUTE SQA gaps #73

cticenhour opened this issue May 15, 2023 · 0 comments
Assignees
@cticenhour
Labels
c: documentation p: normal t: task Label for general tasks

Comments

@cticenhour
Copy link
Member

cticenhour commented May 15, 2023 •
edited
Loading

Description

MALAMUTE has gaps in SQA due to changes in templates from idaholab/moose#20971 and is otherwise missing required documents.

Steps to Reproduce

cd ~/projects/malamute
make -j8
cd doc
./moosedocs.py check

As of 2023/09/28, the check command produces the following output:

Click to see output 
--------------------------------------------------------------------------------
MOOSEAPP REPORT(S):
--------------------------------------------------------------------------------
malamute WARNING
              log_default: 0
           log_stub_files: 16
      log_duplicate_files: 0
  log_missing_description: 9
     log_missing_markdown: 0


--------------------------------------------------------------------------------
DOCUMENT REPORT(S):
--------------------------------------------------------------------------------
Documents WARNING
                                log_default: 0
          log_safety_software_determination: 0
            log_quality_level_determination: 0
          log_enterprise_architecture_entry: 0
                  log_software_quality_plan: 0
          log_configuration_management_plan: 0
                     log_software_test_plan: 0
                  log_asset_management_plan: 0
           log_verification_validation_plan: 0
    log_software_requirements_specification: 0
            log_software_design_description: 0
        log_requirements_traceablity_matrix: 0
         log_verification_validation_report: 0
                log_failure_analysis_report: 0
  log_communication_and_contact_information: 0
              log_software_coding_standards: 0
                  log_software_library_list: 0
                            log_user_manual: 1
                          log_theory_manual: 1



--------------------------------------------------------------------------------
REQUIREMENT REPORT(S):
--------------------------------------------------------------------------------
malamute WARNING
                  log_default: 0
   log_deprecated_requirement: 0
        log_deprecated_design: 0
        log_deprecated_issues: 0
        log_deprecated_detail: 0
  log_deprecated_verification: 0
    log_deprecated_validation: 0
  log_deprecated_with_details: 0
                  log_missing: 2
      log_missing_requirement: 36
           log_missing_design: 36
           log_missing_issues: 0
        log_empty_requirement: 0
             log_empty_design: 0
             log_empty_issues: 0
       log_empty_verification: 0
         log_empty_validation: 0
         log_top_level_detail: 1
           log_missing_detail: 0
             log_empty_detail: 0
        log_extra_requirement: 0
             log_extra_design: 0
             log_extra_issues: 0
        log_extra_collections: 0
       log_invalid_collection: 0
             log_issue_format: 0
             log_design_files: 0
         log_validation_files: 0
       log_verification_files: 0
                 log_testable: 0
    log_duplicate_requirement: 3
         log_duplicate_detail: 0

CRITICAL:0 ERROR:0 WARNING:105

Impact

No impact to end users right now, but MALAMUTE is out-of-compliance with our SQA practices. This might be important in the future.

Checklist for closing this issue
@cticenhour cticenhour added p: normal t: defect Code defect or bug c: documentation t: task Label for general tasks and removed t: defect Code defect or bug labels May 15, 2023
@cticenhour cticenhour self-assigned this May 15, 2023
cticenhour added a commit to cticenhour/malamute that referenced this issue May 15, 2023
@cticenhour
Remove doc warnings related to files that the check command couldn't …
38940cc 
…find

Now the requirement working directories are aligned with MALAMUTE dependencies. Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue May 15, 2023
@cticenhour
Add INL records entries to SQA list, add CCI, adjust website name (id…
4f0e5f3 
…aholab#73)
@cticenhour cticenhour mentioned this issue May 15, 2023
Merged
cticenhour added a commit to cticenhour/malamute that referenced this issue May 17, 2023
@cticenhour
Remove doc warnings related to files that the check command couldn't …
9da6907 
…find

Now the requirement working directories are aligned with MALAMUTE dependencies. Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue May 17, 2023
@cticenhour
Add INL records entries to SQA list, add CCI, adjust website name (id…
e341904 
…aholab#73)
cticenhour added a commit to cticenhour/malamute that referenced this issue May 17, 2023
@cticenhour
Add more content to SQA pages (idaholab#73)
dc8d565 
Still have system purpose/scope to do.
cticenhour added a commit to cticenhour/malamute that referenced this issue May 17, 2023
@cticenhour
Address some SQA check warnings from DED tests and SPS tests. Add exa…
1f66fc0 
…mples directory to list of directories to monitor in check.

Currently: 94 warnings!

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue May 17, 2023
@cticenhour
Fill in system scope and system purpose (idaholab#73)
a75647b
cticenhour added a commit to cticenhour/malamute that referenced this issue May 17, 2023
@cticenhour
Fixup incorrect wording in requirements
5e70d81 
MALAMUTE shall --> The system shall

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Jul 11, 2023
@cticenhour
Adjust content and fix typos in CCI and SDD
1a66dd8 
Refs idaholab#73
@cticenhour cticenhour mentioned this issue Jul 11, 2023
Merged
cticenhour added a commit to cticenhour/malamute that referenced this issue Jul 11, 2023
@cticenhour
Adjust content and fix typos in CCI and SDD
4cc1945 
Refs idaholab#73
@cticenhour cticenhour mentioned this issue Oct 5, 2023
Merged
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: add user manual link to syntax index, disable theory manual chec…
a419c7e 
…k and add reason

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: fixup top level requirement detail warning
5e941f5 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: add missing issue numbers
d8cacf8 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: set all warnings as errors
5c786bc 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: Fixup deprecated 'requirements_traceability_matrix' document nam…
e1c19b4 
…e in sqa_reports.yml

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: add missing class descriptions
365fd62 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: fixup documentation stubs
762d7d8 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: fixup duplicate requirements in gaussian heat source tests
cbc2a03 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 10, 2023
@cticenhour
SQA: skip malamute/examples for requirements/design checks for now
747c5b9 
It should be added back in when the examples selection is more stable and less R&D

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: add user manual link to syntax index, disable theory manual chec…
b6ee71a 
…k and add reason

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: fixup top level requirement detail warning
ce529a5 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: add missing issue numbers
179381d 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: set all warnings as errors
1d87e1e 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: Fixup deprecated 'requirements_traceability_matrix' document nam…
776100b 
…e in sqa_reports.yml

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: add missing class descriptions
c20a85c 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: fixup documentation stubs
4daaacd 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: fixup duplicate requirements in gaussian heat source tests
5da87ef 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Oct 11, 2023
@cticenhour
SQA: skip malamute/examples for requirements/design checks for now
f95271f 
It should be added back in when the examples selection is more stable and less R&D

Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Add commit SHA information to the homepage
60aefb1 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Add commit SHA information to the homepage
52e3083 
Refs idaholab#73
@cticenhour cticenhour mentioned this issue Apr 19, 2024
Merged
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Add commit SHA information to the homepage
f420383 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Add an SQA link in code reliability and development section on homepage
b8d6bc5 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Add content to demonstration page
afb5cd8 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Add formal theory manual page with redirections to VVR and syntax pages
95bfb5f 
Refs idaholab#73
cticenhour added a commit to cticenhour/malamute that referenced this issue Apr 19, 2024
@cticenhour
Address TODO mistakenly committed - demonstration page exists
d01356b 
Refs idaholab#73
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cticenhour cticenhour

Labels
c: documentation p: normal t: task Label for general tasks
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cticenhour