Skip to content

Commit

Permalink
Merge pull request #19 from DEFRA/rb/adp-data-plugin
Browse files Browse the repository at this point in the history
ADP Data Plugin Documentation
  • Loading branch information
RozerinBaran authored Apr 4, 2024
2 parents 1a1bf06 + edb4621 commit a5a249c
Show file tree
Hide file tree
Showing 13 changed files with 122 additions and 5 deletions.

Large diffs are not rendered by default.

20 changes: 17 additions & 3 deletions docs/Getting-Started/onboarding-a-delivery-programme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ uri: https://defra.github.io/adp-documentation/Getting-Started/onboarding-a-deli
authors:
- Lorenzo Squillante
- Logan Talbot
date: 2018-07-10
- Rozerin Baran
date: 2024-03-24
---

# Onboarding a delivery programme
Expand All @@ -32,10 +33,23 @@ By completing the steps in this guide you will be able to:

## Creating a Delivery Programme

....
Once you have navigated to the 'ADP Data' page you will be presented with the 'Delivery Programmes' option.
![ADP Data](../images/adp-data.png)
By clicking 'View' you will have the ability to view existing Delivery Programmes and add new ones if you have the admin permissions.
![View Delivery Programmes](../images/adp-view-delivery-programme.png)

## Entering Delivery Programme information

....
You can start entering Delivery Programme information by clicking the 'Add Delivery Programme' button.
![Add Delivery Programme](../images/adp-create-delivery-programme.png)
You will be presented with various fields; some are optional. For example, the 'Finance Code', 'Website', and 'Alias' are not required, and you can add them later if you wish.

If the Arms Length Body (ALB) for your programme has already been created it will appear in the Arms Length Body dropdown and you will be able to select it accordingly. The programme managers' dropdown should also be pre-populated, and you are able to select more than one manager.

This form includes validation. Once you have completed inputting the Delivery Programme Information and pressed 'create', the validation will run to check if any changes need to be made to your inputs.

## Updating Delivery Programme information

Once you have created your Delivery Programme, you will automatically be redirected to the view page which will allow you to look through existing programmes and edit them.
![Update Delivery Programme](../images/adp-view-edit-delivery-programme.png)

31 changes: 29 additions & 2 deletions docs/Getting-Started/onboarding-a-delivery-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,33 @@ By completing this guide you will have completed these actions:

# Guide

....

## Creating a Delivery Project

Once you have navigated to the 'ADP Data' page you will be presented with the 'Delivery Projects' option.
![ADP Data](../images/adp-data.png)
By clicking 'View' you will have the ability to view existing Delivery Projects and add new ones if you have the admin permissions.
![View Delivery Projects](../images/adp-view-delivery-project.png)

## Entering Delivery Project information

You can start entering Delivery Projects information by clicking the 'Add Delivery Projects' button.
![Add Delivery Projects](../images/adp-create-delivery-project.png)
You will be presented with various fields; some are optional. For example, the 'Alias', 'Website', 'Finance Code' and 'ADO Project' are not required, and you can add them later if you wish.

If the Delivery Programme for your project has already been created it will appear in the Delivery Programme dropdown, and you will be able to select it accordingly.

This form includes validation. Once you have completed inputting the Delivery Project Information and pressed 'create', the validation will run to check if any changes need to be made to your inputs.

### Assign delivery project admins to adminster delivery project.
...
### Adding creation of a new ADO Team on a selected ADO project.
...
### Adding creation of GitHub Team for delivery project.
...
### Adding Azure group(s) for the delivery project's tech users.
...

## Updating Delivery Project information
Once you have created your Delivery Project, you will automatically be redirected to the view page which will allow you to look through existing projects and edit them.
![Update Delivery Projects](../images/adp-view-edit-delivery-project.png)

Binary file added docs/images/adp-create-delivery-programme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-create-delivery-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-data-high-level-process-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-data-portal-permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-view-delivery-programme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-view-delivery-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-view-edit-delivery-programme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/adp-view-edit-delivery-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ nav:
- Catalog Data Sources: Developer-Reference/adp-portal/ongoing-development/catalog-data-sources.md
- GitHub App Permissions: Developer-Reference/adp-portal/ongoing-development/github-app-permissions.md
- Gov.uk Branding: Developer-Reference/adp-portal/ongoing-development/govuk-branding.md
- ADP Data Plugin: Developer-Reference/adp-portal/ongoing-development/adp-data-plugin
- Helm Library Memory & CPU Tiers: Developer-Reference/Infrastructure/helm-library-memory-and-cpu-tiers.md
- Reference Applications:
- FCP Demo Services:
Expand Down

0 comments on commit a5a249c

Please sign in to comment.