Skip to content

Commit f87a31c

Browse files
committed
link correction
1 parent 5ee4e93 commit f87a31c

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/.DS_Store

0 Bytes
Binary file not shown.

docs/Repository_Structure_and_automations/New_Data_Workflow.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ There are two planned routes for entering the required data:
1212
### GitHub form
1313
Github issue templates can be used to guide input in the form of markdown files. More recently the option to use a yml file to create a form has been added. Using this we define an input form with relevant descriptions which once filled creates a formatted issue.
1414

15-
For more information on the syntax (click here)[https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema]
15+
For more information on the syntax [click here](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)
1616

1717
#### Where are the issue forms?
18-
Issue forms reside in the `.workflows/ISSUE_TEMPLATE/` directory. Here we explore the structure of the (`add_institution.yml`)[https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/ISSUE_TEMPLATE/add_institution.yml] template. The structure of this is described below:
18+
Issue forms reside in the `.workflows/ISSUE_TEMPLATE/` directory. Here we explore the structure of the [`add_institution.yml`](https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/ISSUE_TEMPLATE/add_institution.yml) template. The structure of this is described below:
1919

2020
##### Issue Labels
2121
Exploring the source code we can assign automatic labels for when the issue is created:
@@ -96,7 +96,7 @@ On submission, the pre-allocated labels are appended.
9696
9797
## Workflow
9898
99-
When an issue is created or changed, we want to be able to run a series of scripts. These are called workflows. A workflow is defined in `.github/workflows`, with the components of the issue specific workflow (new_issue.yml)[https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/workflows/new_issue.yml] being outlined below.
99+
When an issue is created or changed, we want to be able to run a series of scripts. These are called workflows. A workflow is defined in `.github/workflows`, with the components of the issue specific workflow [new_issue.yml](https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/workflows/new_issue.yml) being outlined below.
100100

101101
### Workflow content
102102

@@ -130,7 +130,7 @@ Instead of duplicating the same processing scripts in every repository we make u
130130

131131
### Reusable Actions.
132132

133-
The reusable action is located as part of the (CMIP-LD repository)[https://github.com/WCRP-CMIP/CMIP-LD/blob/main/actions/new-issue/action.yml].
133+
The reusable action is located as part of the [CMIP-LD repository](https://github.com/WCRP-CMIP/CMIP-LD/blob/main/actions/new-issue/action.yml).
134134

135135
Here the action begins by installing the cmipld python library
136136
```yaml
@@ -161,7 +161,7 @@ We then checkout the repository, and run a set of python scripts. As the python
161161
```
162162

163163
## CMIPLD command line scripts.
164-
When installing a python package, we are able to define entry-points. These are python functions which can be run as command line scripts. For example the `new_issue` command executes the `main` function from (`cmipld.generate.new_issue`)[https://github.com/WCRP-CMIP/CMIP-LD/blob/main/cmipld/generate/new_issue.py].
164+
When installing a python package, we are able to define entry-points. These are python functions which can be run as command line scripts. For example the `new_issue` command executes the `main` function from [`cmipld.generate.new_issue`](https://github.com/WCRP-CMIP/CMIP-LD/blob/main/cmipld/generate/new_issue.py).
165165

166166
This starts by parsing the issue content:
167167
```python
@@ -244,14 +244,14 @@ def run(issue, packet):
244244

245245

246246

247-
247+
<!-- <image src='/assets/demo_images/cli4.png'/> -->
248248
## Quick summary of the submission process
249249
```mermaid
250250
graph TB
251251
A[Run Script] --> B[Update Summary: Issue Content]
252252
B --> C[Update Issue Title and Create Branch]
253253
C --> D[Run Checks]
254-
D --> E[Update Summary: (Data Content)]
254+
D --> E[Update Summary: Data Content]
255255
E --> F[Write Data to File]
256256
F --> G[Commit Changes]
257257
G --> H[Create Pull Request]

0 commit comments

Comments
 (0)