Skip to content

Commit

Permalink
Updates to several metadata requirements
Browse files Browse the repository at this point in the history
Several updates to the metadata requirements pages.
  • Loading branch information
blakemassey-usfws committed Aug 12, 2024
1 parent 194cc55 commit 24aa973
Show file tree
Hide file tree
Showing 11 changed files with 80 additions and 78 deletions.
2 changes: 1 addition & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ website:
href: content/contact_records/contact_records_overview.qmd
contents:
- href: content/contact_records/contact_requirements_summary.qmd
text: "Project/Product Contact Requirements"
text: "Metadata Record Contact Requirements"
- content/contact_records/individual_contacts.qmd
- content/contact_records/organization_contacts.qmd
- section: "Co-Funded Projects"
Expand Down
64 changes: 30 additions & 34 deletions content/metadata_requirements.qmd

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions content/product_records/constraints_tab_product.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ Typically files used will be public domain, but not always.

## Legal

### Access Constraints ([**Required**])`r req_style`
### Access Constraints [(**Required**)]`r req_style`
Access constraints are applied to assure the protection of privacy or
intellectual property and any special restrictions or limitations on obtaining
the resource.

### Use Constraints ([If applicable])`r if_style`
### Use Constraints [(If applicable)]`r if_style`
How the product should be used.

### Other constraints
Expand Down Expand Up @@ -108,7 +108,7 @@ https://creativecommons.org/publicdomain/zero/1.0/

### Security Constraints

#### Classification ([If applicable])`r if_style`
#### Classification [(If applicable)]`r if_style`

A place to describe constraints or restrictions pertaining to security
of the resource. Choose security classification from the drop-down menu.
Expand Down
1 change: 1 addition & 0 deletions content/product_records/distribution_tab_product.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ sent to data.gov.
|               URI | [If Applicable](#uri-if-applicable)`r if_style` |
|               Function | [If Applicable](#function-if-applicable)`r if_style` |
: {.striped .hover .bordered .sm .allborder}

<br/>

Click **Add Distribution Section** and then **Edit Distributors** to begin
Expand Down
5 changes: 3 additions & 2 deletions content/product_records/keywords_tab_product.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ clear results of projects and products.
| Conservation Action Open Standard | [If Applicable](#conservation-action-open-standard-if-applicable)`r if_style` |
| Global Change Master Directory (GCMD) | [Best Practice](#global-change-master-directory-gcmd-best-practice)`r best_style` |
: {.striped .hover .bordered .sm .allborder}

<br/>

## To add Keywords to your Product Record
Expand Down Expand Up @@ -108,7 +109,7 @@ Choose all that apply. The list of options includes the following:

<br/>

### Science Topic ([**Required**]`r req_style`)
### SA Science Topic ([**Required**]`r req_style`)

Choose all that apply. The list of options includes the following:

Expand Down Expand Up @@ -196,7 +197,7 @@ keywords for conservation actions are as listed:

<br/>

### Global Change Master Directory (GCMD) ([Best Practice])`r if_style`
### Global Change Master Directory (GCMD) ([Best Practice])`r best_style`

**GCMD** stands for Global Change Master Directory and these keywords are
maintained by NASA. Look for useful keywords in the GCMD Science Keywords.
Expand Down
16 changes: 9 additions & 7 deletions content/product_records/main_tab_product.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ best_style <- paste0('{style="color:', best_practice_color, ';"}')
other_style <- paste0('{style="color:', best_practice_color, ';"}')
```


The **Main** tab allows for the creation and/or editing of primary metadata.

| Metadata Field | Product Records |
Expand Down Expand Up @@ -55,6 +54,7 @@ The **Main** tab allows for the creation and/or editing of primary metadata.
|        Start Date | [If Applicable](#time-period)`r if_style` |
|        End Date | [**Required**](#time-period)`r req_style`^\*^ |
: {.striped .hover .bordered .sm .allborder}

<br/>

## Basic Information
Expand Down Expand Up @@ -98,7 +98,7 @@ optional - you can leave this blank or enter a shorten project name.
Products must have a specific resource type selected, NOT just "product".
:::

## Point of Contacts [(Required)]`r req_style`
## Points of Contact [(Required)]`r req_style`

Adding a point of contact gives staff information on who to contact should they
have a question regarding your project or product. From the **Role** drop-down
Expand All @@ -107,6 +107,8 @@ contact from the list of contacts. See the
[Contact Records](../contact_records/contact_records_overview.qmd)
section for information on creating contacts.

Add additional Points of Contact as listed in the table below.

| Role | Contact | Required? |
|:----------------------|:---------------------------------------|:--------------------------|
| pointOfContact | FWS Science Applications National Data Steward | [**Required**]`r req_style` |
Expand Down Expand Up @@ -254,12 +256,12 @@ Enter comments, if desired.

## Time Period

### Dates [(If available)]`r if_style`
### Start Date and End Date [(Required)]`r if_style`

**Time Period** refers to project start and end date, or the date that the
product was applicable. For example, the time when a map is valid, date of
publication, date of presentation, or dates when the data was collected.
**Time Period** refers to when date the product was applicable, For example,
the time when a map is valid, date of publication, date of presentation, or
dates when the data was collected. For each product, enter a **Start Date** and
**End Date**.

- **Required**: For each product, add a start date and end date.

![](../../assets/example_time_period.png)
1 change: 1 addition & 0 deletions content/product_records/metadata_tab_product.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ metadata, and metadata repositories.
| Parent Metadata | [**Required**](#parent-metadata)`r req_style`|
| Metadata Repositories | [**Required**](#metadata-repositories)`r req_style`|
: {.striped .hover .bordered .sm .allborder}

<br/>

## Basic Information
Expand Down
37 changes: 19 additions & 18 deletions content/project_records/funding_tab_project.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Service can be identified as the funding source and the funding administrator
may also include "Ecological Services" or a specific field office.
:::

### Marked Funding ([Best Practice]`r if_style`)
### Marked Funding ([If applicable]`r if_style`)

In some cases, funds are marked for specific activities and include reporting
requirements that accompany the funding allocations. For example, EPA allocates
Expand All @@ -138,22 +138,6 @@ Funding Other Contacts.
![Example of organizational fund contact entry](../../assets/example_organizational_contact.png)

![Example of organizational fund entry in Funding metadata entry](../../assets/example_funding_entry.png)

### Description ([Best Practice]`r if_style`)

In order to better integrate budgeting records and align with activity tracking
priorities, add the ***FWS Sub-Activity***, ***Funding Codes***, and
***Agreement Type*** to the Description.

For example, the text entry may look like this:
FWS sub-activity 1420, fundcode 190, contract. If funds are provided from
multiple sub-activities, please add this in the description (i.e. FWS
sub-activity 1430, fundcode 170, \$30,000: sub-activity 1420, fundcode 170,
\$10,000). At some point in the future, mdEditor may include additional fields
for these values.

![Example budgeting information in Allocation Description](../../assets/example_budgeting_infomation.png)

### Matching and In-kind Funds ([If applicable]`r if_style`)

Project funds or in-kind support that were supplied by a partner (i.e., not
Expand All @@ -179,7 +163,24 @@ Use the “Pick a Fiscal Year” dropdown to autofill the date fields.

![](../../assets/project_funding_timeperiod.png)


### Description ([Best Practice]`r if_style`)

In order to better integrate budgeting records and align with activity tracking
priorities, add the ***FWS Sub-Activity***, ***Funding Codes***, and
***Agreement Type*** to the Description.

For example, the text entry may look like this:
FWS sub-activity 1420, fundcode 190, contract. If funds are provided from
multiple sub-activities, please add this in the description (i.e. FWS
sub-activity 1430, fundcode 170, \$30,000: sub-activity 1420, fundcode 170,
\$10,000). At some point in the future, mdEditor may include additional fields
for these values.

![Example budgeting information in Allocation Description](../../assets/example_budgeting_infomation.png)


Example of multiple allocations across several fiscal years for a single project
record.

![](../../assets/project_funding_list.png)
![](../../assets/project_funding_list.png)
6 changes: 3 additions & 3 deletions content/project_records/keywords_tab_project.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Choose all that apply. The list of options includes the following:

<br/>

### Science Topic ([**Required**]`r req_style`)
### SA Science Topic ([**Required**]`r req_style`)

Choose all that apply. The list of options includes the following:

Expand Down Expand Up @@ -141,7 +141,7 @@ Choose all that apply. The list of options includes the following:

<br/>

### Conservation Action Open Standard ([Requied, if applicable**]`r if_style`)
### Conservation Action Open Standard ([If applicable**]`r if_style`)

The Open Standards for the Practice of Conservation is a globally utilized
nomenclature for conservation. Including these keywords helps to align the work
Expand Down Expand Up @@ -195,7 +195,7 @@ keywords for conservation actions are as listed:

<br/>

### GCMD ([Best Practice]`r if_style`)
### Global Change Master Directory (GCMD) ([Best Practice]`r if_style`)

**GCMD** stands for Global Change Master Directory and these keywords are
maintained by NASA. Look for useful keywords in the GCMD Science Keywords.
Expand Down
19 changes: 9 additions & 10 deletions content/project_records/main_tab_project.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,16 @@ enter a shorten project name.

![](../../assets/resource_types.png)

## Points of Contacts [(Required)]`r req_style`
## Points of Contact [(Required)]`r req_style`

Adding a **Point of Contact** gives users information on who to contact should
they have a question regarding your project or product.
Adding a point of contact gives staff information on who to contact should they
have a question regarding your project or product. From the **Role** drop-down
menu, select **pointOfContact**. From the **Contacts** drop-down menu, select a
contact from the list of contacts. See the
[Contact Records](../contact_records/contact_records_overview.qmd)
section for information on creating contacts.

:::{.callout-note icon=false}
To add contacts to a metadata record, you must first create/upload the contacts
into mdEditor. See the [Contact
Records](../contact_records/contact_records_overview.qmd) Section for more
information.
:::
Add additional Points of Contact as listed in the table below.

| Role | Contact | Requirements |
|---------------------|----------------------------------------|---------------------|
Expand Down Expand Up @@ -242,7 +241,7 @@ For the **Supplemental Information** enter comments, if desired.

## Time Period

### Dates [(Required)]`r req_style`
### Start Date and End Date [(Required)]`r if_style`

For each project, add a **Start Date** and **End Date**. If the project
spanned a single fiscal year, you can use the “Pick a Fiscal Year” drop-down to
Expand Down
1 change: 1 addition & 0 deletions content/project_records/taxonomy_tab_project.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ recommended for products (if applicable).
| Taxonomic System |[If Applicable](#add-taxonomic-system)`r if_style` |
| Taxonomic Classification |[If Applicable](#add-taxonomic-system)`r if_style` |
: {.striped .hover .bordered .sm .allborder}

<br/>

## Taxonomy
Expand Down

0 comments on commit 24aa973

Please sign in to comment.