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

Compute RP feedback - improve ReadTheDocs web navigation of docs #68

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Compute RP feedback - improve ReadTheDocs web navigation of docs #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1abd8d9
move roadmap-specific directories, remove uneeded individual index.rst
Dec 1, 2023
2899785
convert rst -> md for index and tasks/index
Dec 1, 2023
0c8330f
update main project name be similar to url name
Dec 1, 2023
94db248
convert all roadmaps to use toctree
Dec 1, 2023
cc1b29f
ensure h3 for phases same across all roadmap tracks
Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 37 additions & 40 deletions ...loud_-_Integration_Roadmap_Description.md → ...loud_-_Integration_Roadmap_Description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,45 +40,42 @@ Please track RP integration progress in [*this spreadsheet*](https://docs.google

- [*ACCESS RP Roadmaps FAQ*](https://docs.google.com/document/d/1VwYROB7sh4X_Tqvi_4XIkYD-jffBS4UykS6gEJesuQE/)

## Planning phase

1. Coordination: [ACCESS Allocated Resource Integration Coordination v1](../tasks/ACCESS_Allocated_Resource_Integration_Coordination_v1.md)

2. Coordination: [Infrastructure Description v2](../tasks/Infrastructure_Description_v2.md)

3. Technology: [Cybersecurity Requirements for RPs v1](../tasks/Cybersecurity_Requirements_for_RPs_v1.md)

4. Technology: [Data and Network Integration v1](../tasks/Data_and_Network_Integration.md)

## Integration phase

5. Coordination: [ACCESS Allocation Policies v1](../tasks/ACCESS_Allocation_Policies_v1.md)

6. Coordination: [Knowledge Base v1](../tasks/Knowledge_Base_v1.md)

7. Coordination: [RP Forum Participation v1](../tasks/Resource_Provider_Forum_Participation_v1.md)

8. Coordination: [Cybersecurity Governance Council Participation v1](../tasks/Cybersecurity_Governance_Council_Participation_v1.md)

9. Technology: [Resource Metrics Data Availability Assessment v1](../tasks/Resource_Metrics_Data_Availability_Assessment_v1.md)

10. (Optional) Technology: [ACCESS DNS Entries v1](../tasks/ACCESS_DNS_Records_v1.md)

11. (Optional) Technology: [Local Service ACCESS IAM Integration v1](../tasks/Local_Services_ACCESS_IAM_Integration_v1.md)

## Operations phase

12. Support: [Incident Response and Coordination v1](../tasks/Incident_Response_and_Coordination_v1.md)

13. Support: [Ticket Handling v2](../tasks/Ticket_Handling_v2.md)

14. Support: [Operational Status Communications v1](../tasks/Operational_Status_Communications_v1.md)

15. (Optional) Support: [Request RP or Site Staff Allocation v1](../tasks/Request_RP_or_Site_Staff_Allocation_v1.md)

16. Technology: [AMIE and Usage Reporting v1](../tasks/AMIE_and_Usage_Reporting_v1.md)

17. Technology: [Performance Data reporting v1](../tasks/Performance_Data_Reporting_v1.md)
## Phases

### Planning phase
```{toctree}
:maxdepth: 1

1. Coordination: ACCESS Allocated Resource Integration Coordination <tasks/ACCESS_Allocated_Resource_Integration_Coordination_v1.md>
2. Coordination: Infrastructure Description <tasks/Infrastructure_Description_v2.md>
3. Technology: Cybersecurity Requirements for RPs <tasks/Cybersecurity_Requirements_for_RPs_v1.md>
4. Technology: Data and Network Integration <tasks/Data_and_Network_Integration.md>
```

### Integration phase
```{toctree}
:maxdepth: 1

5. Coordination: ACCESS Allocation Policies <tasks/ACCESS_Allocation_Policies_v1.md>
6. Coordination: Knowledge Base <tasks/Knowledge_Base_v1.md>
7. Coordination: RP Forum Participation <tasks/Resource_Provider_Forum_Participation_v1.md>
8. Coordination: Cybersecurity Governance Council Participation <tasks/Cybersecurity_Governance_Council_Participation_v1.md>
9. Technology: Resource Metrics Data Availability Assessment <tasks/Resource_Metrics_Data_Availability_Assessment_v1.md>
10. (Optional) Technology: ACCESS DNS Entries <tasks/ACCESS_DNS_Records_v1.md>
11. (Optional) Technology: Local Service ACCESS IAM Integration <tasks/Local_Services_ACCESS_IAM_Integration_v1.md>
```

### Operations phase
```{toctree}
:maxdepth: 1

12. Support: Incident Response and Coordination <tasks/Incident_Response_and_Coordination_v1.md>
13. Support: Ticket Handling <tasks/Ticket_Handling_v2.md>
14. Support: Operational Status Communications <tasks/Operational_Status_Communications_v1.md>
15. (Optional) Support: Request RP or Site Staff Allocation <tasks/Request_RP_or_Site_Staff_Allocation_v1.md>
16. Technology: AMIE and Usage Reporting <tasks/AMIE_and_Usage_Reporting_v1.md>
17. Technology: Performance Data reporting <tasks/Performance_Data_Reporting_v1.md>
```

## Document Management

Expand All @@ -88,6 +85,6 @@ Please track RP integration progress in [*this spreadsheet*](https://docs.google

**Coordinators**: Chris Martin, ACCESS Operations

**Last revised date**: 08/22/2023
**Last revised date**: 12/01/2023

**Retired date**:
71 changes: 34 additions & 37 deletions ...pute_-_Integration_Roadmap_Description.md → ...pute_-_Integration_Roadmap_Description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,51 +40,48 @@ Please track RP integration progress in [*this spreadsheet*](https://docs.google

- [*ACCESS RP Roadmaps FAQ*](https://docs.google.com/document/d/1VwYROB7sh4X_Tqvi_4XIkYD-jffBS4UykS6gEJesuQE/)

## Planning phase
## Phases

1. Coordination: [ACCESS Allocated Resource Integration Coordination v1](../tasks/ACCESS_Allocated_Resource_Integration_Coordination_v1.md)
### Planning phase

2. Coordination: [Infrastructure Description v2](../tasks/Infrastructure_Description_v2.md)
```{toctree}
:maxdepth: 1

3. Technology: [Cybersecurity Requirements for RPs v1](../tasks/Cybersecurity_Requirements_for_RPs_v1.md)
1. Coordination: ACCESS Allocated Resource Integration Coordination <tasks/ACCESS_Allocated_Resource_Integration_Coordination_v1.md>
2. Coordination: Infrastructure Description <tasks/Infrastructure_Description_v2.md>
3. Technology: Cybersecurity Requirements for RPs <tasks/Cybersecurity_Requirements_for_RPs_v1.md>
4. Technology: Data and Network Integration <tasks/Data_and_Network_Integration.md>
```

4. Technology: [Data and Network Integration v1](../tasks/Data_and_Network_Integration.md)
### Integration phase

## Integration phase
```{toctree}
:maxdepth: 1

5. Coordination: [ACCESS Allocation Policies v1](../tasks/ACCESS_Allocation_Policies_v1.md)
5. Coordination: ACCESS Allocation Policies <tasks/ACCESS_Allocation_Policies_v1.md>
6. Coordination: Knowledge Base <tasks/Knowledge_Base_v1.md>
7. Coordination: RP Forum Participation <tasks/Resource_Provider_Forum_Participation_v1.md>
8. Coordination: Cybersecurity Governance Council Participation <tasks/Cybersecurity_Governance_Council_Participation_v1.md>
9. Technology: Resource Metrics Data Availability Assessment <tasks/Resource_Metrics_Data_Availability_Assessment_v1.md>
10. (Optional) Technology: ACCESS DNS Entries <tasks/ACCESS_DNS_Records_v1.md>
11. (Optional) Technology: Local Service ACCESS IAM Integration <tasks/Local_Services_ACCESS_IAM_Integration_v1.md>
12. (Optional) Technology: ACCESS OnDemand Portal Integration <tasks/ACCESS_OnDemand_Portal_Integration_v1.md>
```

6. Coordination: [Knowledge Base v1](../tasks/Knowledge_Base_v1.md)
### Operations phase

7. Coordination: [RP Forum Participation v1](../tasks/Resource_Provider_Forum_Participation_v1.md)
```{toctree}
:maxdepth: 1

8. Coordination: [Cybersecurity Governance Council Participation v1](../tasks/Cybersecurity_Governance_Council_Participation_v1.md)

9. Technology: [Resource Metrics Data Availability Assessment v1](../tasks/Resource_Metrics_Data_Availability_Assessment_v1.md)

10. (Optional) Technology: [ACCESS DNS Entries v1](../tasks/ACCESS_DNS_Records_v1.md) (NEW)

11. (Optional) Technology: [Local Service ACCESS IAM Integration v1](../tasks/Local_Services_ACCESS_IAM_Integration_v1.md)

12. (Optional) Technology: [ACCESS OnDemand Portal Integration v1](../tasks/ACCESS_OnDemand_Portal_Integration_v1.md)

## Operations phase

13. Technology: [Deploy Globus Endpoint v1](../tasks/Deploy_Globus_Endpoint_v1.md)

14. Technology: [Publish Dynamic Resource Information v2](../tasks/Publish_Dynamic_Resource_Information_v2.md)

15. Support: [Incident Response and Coordination v1](../tasks/Incident_Response_and_Coordination_v1.md)

16. Support: [Ticket Handling v2](../tasks/Ticket_Handling_v2.md)

17. Support: [Operational Status Communications v1](../tasks/Operational_Status_Communications_v1.md)

18. (Optional) Support: [Request RP or Site Staff Allocation v1](../tasks/Request_RP_or_Site_Staff_Allocation_v1.md)

19. Technology: [AMIE and Usage Reporting v1](../tasks/AMIE_and_Usage_Reporting_v1.md)

20. Technology: [Performance Data reporting v1](../tasks/Performance_Data_Reporting_v1.md)
13. Technology: Deploy Globus Endpoint <tasks/Deploy_Globus_Endpoint_v1.md>
14. Technology: Publish Dynamic Resource Information <tasks/Publish_Dynamic_Resource_Information_v2.md>
15. Support: Incident Response and Coordination <tasks/Incident_Response_and_Coordination_v1.md>
16. Support: Ticket Handling <tasks/Ticket_Handling_v2.md>
17. Support: Operational Status Communications <tasks/Operational_Status_Communications_v1.md>
18. (Optional) Support: Request RP or Site Staff Allocation <tasks/Request_RP_or_Site_Staff_Allocation_v1.md>
19. Technology: AMIE and Usage Reporting <tasks/AMIE_and_Usage_Reporting_v1.md>
20. Technology: Performance Data reporting <tasks/Performance_Data_Reporting_v1.md>
```

## Document Management

Expand All @@ -94,6 +91,6 @@ Please track RP integration progress in [*this spreadsheet*](https://docs.google

**Coordinators**: Jess Haney, ACCESS Operations

**Last revised date**: 08/22/2023
**Last revised date**: 12/01/2023

**Retired date**:
65 changes: 32 additions & 33 deletions ...rage_-_Integration_Roadmap_Description.md → ...rage_-_Integration_Roadmap_Description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,47 +40,46 @@ Please track RP integration progress in [*this spreadsheet*](https://docs.google

- [*ACCESS RP Roadmaps FAQ*](https://docs.google.com/document/d/1VwYROB7sh4X_Tqvi_4XIkYD-jffBS4UykS6gEJesuQE/)

## Planning phase
## Phases

1. Coordination: [ACCESS Allocated Resource Integration Coordination v1](../tasks/ACCESS_Allocated_Resource_Integration_Coordination_v1.md)
### Planning phase

2. Coordination: [Infrastructure Description v2](../tasks/Infrastructure_Description_v2.md)
```{toctree}
:maxdepth: 1

3. Technology: [Cybersecurity Requirements for RPs v1](../tasks/Cybersecurity_Requirements_for_RPs_v1.md)
1. Coordination: ACCESS Allocated Resource Integration Coordination <tasks/ACCESS_Allocated_Resource_Integration_Coordination_v1.md>
2. Coordination: Infrastructure Description <tasks/Infrastructure_Description_v2.md>
3. Technology: Cybersecurity Requirements for RPs <tasks/Cybersecurity_Requirements_for_RPs_v1.md>
4. Technology: Data and Network Integration <tasks/Data_and_Network_Integration.md>
```

4. Technology: [Data and Network Integration v1](../tasks/Data_and_Network_Integration.md)
### Integration phase

## Integration phase
```{toctree}
:maxdepth: 1

5. Coordination: [ACCESS Allocation Policies v1](../tasks/ACCESS_Allocation_Policies_v1.md)
5. Coordination: ACCESS Allocation Policies <tasks/ACCESS_Allocation_Policies_v1.md>
6. Coordination: Knowledge Base <tasks/Knowledge_Base_v1.md>
7. Coordination: RP Forum Participation <tasks/Resource_Provider_Forum_Participation_v1.md>
8. Coordination: Cybersecurity Governance Council Participation <tasks/Cybersecurity_Governance_Council_Participation_v1.md>
9. Technology: Resource Metrics Data Availability Assessment <tasks/Resource_Metrics_Data_Availability_Assessment_v1.md>
10. (Optional) Technology: ACCESS DNS Entries <tasks/ACCESS_DNS_Records_v1.md>
11. (Optional) Technology: Local Service ACCESS IAM Integration <tasks/Local_Services_ACCESS_IAM_Integration_v1.md>
```

6. Coordination: [Knowledge Base v1](../tasks/Knowledge_Base_v1.md)
### Operations phase

7. Coordination: [RP Forum Participation v1](../tasks/Resource_Provider_Forum_Participation_v1.md)
```{toctree}
:maxdepth: 1

8. Coordination: [Cybersecurity Governance Council Participation v1](../tasks/Cybersecurity_Governance_Council_Participation_v1.md)

9. Technology: [Resource Metrics Data Availability Assessment v1](../tasks/Resource_Metrics_Data_Availability_Assessment_v1.md)

10. (Optional) Technology: [ACCESS DNS Entries v1](../tasks/ACCESS_DNS_Records_v1.md)

11. (Optional) Technology: [Local Service ACCESS IAM Integration v1](../tasks/Local_Services_ACCESS_IAM_Integration_v1.md)

## Operations phase

12. Technology: [Deploy Globus Endpoint v1](../tasks/Deploy_Globus_Endpoint_v1.md)

13. Support: [Incident Response and Coordination v1](../tasks/Incident_Response_and_Coordination_v1.md)

14. Support: [Ticket Handling v2](../tasks/Ticket_Handling_v2.md)

15. Support: [Operational Status Communications v1](../tasks/Operational_Status_Communications_v1.md)

16. (Optional) Support: [Request RP or Site Staff Allocation v1](../tasks/Request_RP_or_Site_Staff_Allocation_v1.md)

17. Technology: [AMIE and Usage Reporting v1](../tasks/AMIE_and_Usage_Reporting_v1.md)

18. Technology: [Performance Data reporting v1](../tasks/Performance_Data_Reporting_v1.md)
12. Technology: Deploy Globus Endpoint <tasks/Deploy_Globus_Endpoint_v1.md>
13. Support: Incident Response and Coordination <tasks/Incident_Response_and_Coordination_v1.md>
14. Support: Ticket Handling <tasks/Ticket_Handling_v2.md>
15. Support: Operational Status Communications <tasks/Operational_Status_Communications_v1.md>
16. (Optional) Support: Request RP or Site Staff Allocation <tasks/Request_RP_or_Site_Staff_Allocation_v1.md>
17. Technology: AMIE and Usage Reporting <tasks/AMIE_and_Usage_Reporting_v1.md>
18. Technology: Performance Data reporting <tasks/Performance_Data_Reporting_v1.md>
```

## Document Management

Expand All @@ -90,6 +89,6 @@ Please track RP integration progress in [*this spreadsheet*](https://docs.google

**Coordinators**: Lee Liming, ACCESS Operations

**Last revised date**: 08/22/2023
**Last revised date**: 12/01/2023

**Retired date**:
28 changes: 17 additions & 11 deletions ...eway_-_Integration_Roadmap_Description.md → ...eway_-_Integration_Roadmap_Description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,28 @@ Operators must perform the Required Tasks below and may perform the Optional Tas

- [*Introduction to Roadmaps*](https://docs.google.com/presentation/d/1OjeT6r01mdOIa4pq1VE0L5ocRPfqdXFp9QsADjdqrjE/) slides

## Planning phase
1. Coordination: [ACCESS Science Gateway Integration Coordination v1](../tasks/ACCESS_Science_Gateway_Integration_Coordination_v1.md)
## Phases

## Integration/Operations phase(s)
### Planning phase

2. Coordination/Support: [Science Gateway Description v1](../tasks/Science_Gateway_Description_v1.md)
```{toctree}
:maxdepth: 1

3. Coordination/Support: [Request Science Gateway Allocation v1](../tasks/Request_Science_Gateway_Allocation_v1.md)
1. Coordination: ACCESS Science Gateway Integration Coordination <tasks/ACCESS_Science_Gateway_Integration_Coordination_v1.md>
```

4. Coordination/Support: [Request Science Gateway Resources v1](../tasks/Request_Science_Gateway_Resources_v1.md)
### Integration/Operations phases

5. Coordination/Support: [ACCESS Affinity Groups and Science Gateways v1](../tasks/ACCESS_Affinity_Groups_and_Science_Gateways_v1.md)
```{toctree}
:maxdepth: 1

6. Coordination/Support: [Request Science Gateway Community Accounts v1](../tasks/Request_Science_Gateway_Community_Accounts_v1.md)

7. Coordination/Support: [Science Gateway Usage Reporting v1](../tasks/Science_Gateway_Usage_Reporting_v1.md)
2. Coordination/Support: Science Gateway Description <tasks/Science_Gateway_Description_v1.md>
3. Coordination/Support: Request Science Gateway Allocation <tasks/Request_Science_Gateway_Allocation_v1.md>
4. Coordination/Support: Request Science Gateway Resources <tasks/Request_Science_Gateway_Resources_v1.md>
5. Coordination/Support: ACCESS Affinity Groups and Science Gateways <tasks/ACCESS_Affinity_Groups_and_Science_Gateways_v1.md>
6. Coordination/Support: Request Science Gateway Community Accounts <tasks/Request_Science_Gateway_Community_Accounts_v1.md>
7. Coordination/Support: Science Gateway Usage Reporting <tasks/Science_Gateway_Usage_Reporting_v1.md>
```

## Document Management

Expand All @@ -57,6 +63,6 @@ Operators must perform the Required Tasks below and may perform the Optional Tas

**Coordinators**: Rob Quick, ACCESS Operations

**Last revised date**: 08/22/2023
**Last revised date**: 12/01/2023

**Retired date**:
45 changes: 25 additions & 20 deletions ...vice_-_Integration_Roadmap_Description.md → ...vice_-_Integration_Roadmap_Description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,34 +26,39 @@ See related [*Roadmap Task Timeline*](https://docs.google.com/presentation/d/1GI

- [*Introduction to Roadmaps*](https://docs.google.com/presentation/d/1OjeT6r01mdOIa4pq1VE0L5ocRPfqdXFp9QsADjdqrjE/) slides

## Planning phase
## Phases

1. Coordination: [Infrastructure Description v2](../tasks/Infrastructure_Description_v2.md)
### Planning phase

2. Technology: [Cybersecurity Requirements for ACCESS Services v1](../tasks/Cybersecurity_Requirements_for_ACCESS_Services_v1.md)
```{toctree}
:maxdepth: 1

## Integration phase
1. Coordination: Infrastructure Description <tasks/Infrastructure_Description_v2.md>
2. Technology: Cybersecurity Requirements for ACCESS Services <tasks/Cybersecurity_Requirements_for_ACCESS_Services_v1.md>
```

3. Coordination: [Cybersecurity Governance Council Participation v1](../tasks/Cybersecurity_Governance_Council_Participation_v1.md)
### Integration phase

4. (Optional) Technology: [ACCESS DNS Entries v1](../tasks/ACCESS_DNS_Records_v1.md)
```{toctree}
:maxdepth: 1

5. (Optional) Technology: [Local Service ACCESS IAM Integration v1](../tasks/Local_Services_ACCESS_IAM_Integration_v1.md)
3. Coordination: Cybersecurity Governance Council Participation <tasks/Cybersecurity_Governance_Council_Participation_v1.md>
4. (Optional) Technology: ACCESS DNS Entries <tasks/ACCESS_DNS_Records_v1.md>
5. (Optional) Technology: Local Service ACCESS IAM Integration <tasks/Local_Services_ACCESS_IAM_Integration_v1.md>
6. (Optional) Support: Request RP or Site Staff Allocation <tasks/Request_RP_or_Site_Staff_Allocation_v1.md>
7. Coordination: Online Service Documentation <tasks/Online_Service_Documentation_v1.md>
```

6. (Optional) Support: [Request RP or Site Staff Allocation v1](../tasks/Request_RP_or_Site_Staff_Allocation_v1.md)
### Operations phase

7. Coordination: [Online Service Documentation v1](../tasks/Online_Service_Documentation_v1.md)
```{toctree}
:maxdepth: 1


## Operations phase

8. Support: [Incident Response and Coordination v1](../tasks/Incident_Response_and_Coordination_v1.md)

9. Support: [Ticket Handling v2](../tasks/Ticket_Handling_v2.md)

10. Support: [Operational Status Communications v1](../tasks/Operational_Status_Communications_v1.md)

11. (Optional) Technology: [Performance Data reporting v1](../tasks/Performance_Data_Reporting_v1.md)
8. Support: Incident Response and Coordination <tasks/Incident_Response_and_Coordination_v1.md>
9. Support: Ticket Handling <tasks/Ticket_Handling_v2.md>
10. Support: Operational Status Communications <tasks/Operational_Status_Communications_v1.md>
11. (Optional) Technology: Performance Data reporting <tasks/Performance_Data_Reporting_v1.md>
```

## Document Management

Expand All @@ -63,6 +68,6 @@ See related [*Roadmap Task Timeline*](https://docs.google.com/presentation/d/1GI

**Coordinators**: JP Navarro, ACCESS Operations

**Last revised date**: 08/22/2023
**Last revised date**: 12/01/2023

**Retired date**:
11 changes: 0 additions & 11 deletions docs/source/cloud/index.rst
View file
Open in desktop

This file was deleted.

Loading