Skip to content

Commit

Permalink
Merge pull request #16 from orppst/Documentation
Browse files Browse the repository at this point in the history 
Documentation update
  • Loading branch information
@pahjbo
pahjbo authored Jun 28, 2024
2 parents f196cea + ad620c7 commit dfb1bfc
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/Design/Approach.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ the Extensions. The numbered steps in the Extensions correspond to the MSS steps

Some use cases (eg, maintaining investigators) and components (eg audit activity) are called by other use cases, (eg, create a proposal, edit a proposal). Such items are declared just once and referenced by name with a bold italic hyperlink. Click the hyperlink to see the detail and then return with the browser back button.

The data models can be found [***here***](https://github.com/ivoa/ProposalDM).
The data models can be found in a [separate project](https://ivoa.github.io/ProposalDM/).

The UI is documented elsewhere.
51 changes: 51 additions & 0 deletions docs/Project Management/DeliveryPlan.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

# ***Delivery Plan***

Planned Delivery dates

Phase 1 :

Phase 2 :

Phase 3 :


| Epic | Story | Phase 1 | Phase 2 | Phase 3 |
|-----------------------|-----------------------------------------------------------------------------------------------|---------|---------|---------|
| Manage Reference Data | UC02 Create observatory admin | Phase 1 | | |
| | UC03 Configure observatory | Phase 1 | | |
| | UC 04 Create new proposal cycle | Phase 1 | | |
| | UC08 Create TAC Chair | | Phase 2 | |
| | UC09 Add TAC members | | Phase 2 | |
| | UC16 Assign internal reviewer | | Phase 2 | |
| | UC17 Assign external reviewer | | Phase 2 | |
| | | | | |
| Deploy System | UC00 Deploy the system | Phase 1 | | |
| | UC01 User registers to the system | Phase 1 | | |
| | | | | |
| Assemble Proposal | UC05 Create observing proposal | Phase 1 | | |
| | UC06 Edit observing proposal | Phase 1 | | |
| | UC07 Submit a proposal | Phase 1 | | |
| | UC15 Import whole proposal | | Phase 2 | |
| | UC20 Clone proposal | | Phase 2 | |
| | UC21 Withdraw proposal | | | Phase 3 |
| | | | | |
| Consider Proposal | UC10 Review proposals | | Phase 2 | |
| | UC11 Score proposals | | Phase 2 | |
| | UC12 Assign observing time | | Phase 2 | |
| | UC13 Inform PIs about allocation | | | Phase 3 |
| | UC18 Review proposal scores | | Phase 2 | |
| | UC22 Revoke allocation | | | Phase 3 |
| | | | | |
| Common | UC14 Export whole proposal | | Phase 2 | |
| | | | | |
| Manage Hardware | Procure, configure, and deliver Dev application servers,with agreed standby | Phase 1 | | |
| | Procure, configure, and deliver Stage and Production application servers, with agreed standby | | Phase 2 | |
| | | | | |
| Manage DBMS | Procure, configure, and deliver Dev database servers, with agreed standby | Phase 1 | | |
| | Procure, configure, and deliver Stage and Production database servers, with agreed standby | | Phase 2 | |
| | Implement database security | Phase 1 | | |
| | Implement agreed data backup strategy | Phase 1 | | |
| | | | | |
| Statistics | Monitor Production system usage | | | Phase 3 |

20 changes: 10 additions & 10 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,18 @@ nav:
- Architecture: Developer/architecture.md
- Data Model: Developer/ProposalDM.md
- API: Developer/api.md
- Design:
- Approach: Design/Approach.md
- Purpose and Scope: Design/PurposeAndScope.md
- Business Requirements: Design/BusinessRequirements.md
- Business Rules: Design/BusinessRules.md
- Components: Design/Components.md
- Non-functional Requirements: Design/NFRs.md
- Project Management:
- Project Management: Project Management/ProjectManagement.md
- Delivery Plan: Project Management/DeliveryPlan.md
- Deployment:
- Getting Started: Deployment/index.md
# 2024-06-24 mwa design and proj mgt
- Design:
- Approach: Design/Approach.md
- Purpose and Scope: Design/PurposeAndScope.md
- Business Requirements: Design/BusinessRequirements.md
- Business Rules: Design/BusinessRules.md
- Components: Design/Components.md
- Non-functional Requirements: Design/NFRs.md
- Project Management: Project Management/ProjectManagement.md
# 2024-06-24 mwa
theme:
name: material
features:
Expand Down

0 comments on commit dfb1bfc

Please sign in to comment.