feat: cfc metadata

[wgwz]

Description

Closes: https://github.com/regen-network/regen-registry/issues/1121

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

• [ ] provided a link to the relevant issue or specification
• [ ] reviewed "Files changed" and left comments if necessary

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

• [ ] confirmed all author checklist items have been addressed
• [ ] reviewed code correctness and readability
• [ ] reviewed documentation is accurate
• [ ] manually tested (if applicable)

[wgwz]

@S4mmyb @mhagel left some comments to guide through the changes.

the most important files to review are the actual metadata:

• https://github.com/regen-network/regen-registry-standards/blob/kyle/1121-CFC-metadata/ops/C02/credit-class-metadata/C02-city-forest-credits-credit-class.jsonld
• https://github.com/regen-network/regen-registry-standards/blob/kyle/1121-CFC-metadata/ops/C02/project-metadata/C02-city-forest-credits-project-009.jsonld
• https://github.com/regen-network/regen-registry-standards/blob/kyle/1121-CFC-metadata/ops/C02/project-metadata/C02-city-forest-credits-project-015.jsonld
• batches: https://github.com/regen-network/regen-registry-standards/tree/kyle/1121-CFC-metadata/ops/C02/credit-batch-metadata

then the shacl/ and the jsonld/ templates (see those folders for changes related to C02).

NOTE: i didn't write the shacl template for the C02 projects yet @S4mmyb since you mentioned that we're going to use the UI to create those and there was a big of ambiguity there.

[wgwz]

this is just a note that we might be able to use this method for sort of "inheriting" certain properties of other shapes:

https://book.validatingrdf.com/bookHtml011.html#sec126

/cc @mhagel

[S4mmyb]

Hey @wgwz , thanks for the PR! I requested a few changes, mostly in the templated docs. For the most part it looks good - I think one thing we want to make sure of is that when the the user flow to create a project page is being used it correctly fills out the fields in the json-ld being populated behind the scenes. This includes:

• projectName
• projectDecription
• projectSize
• projectOperator (via the roles section)
• projectLocation

I also noticed that we don't have in here a section for media or project photos. I'm sure this is being automatically populated in the user-interface, we just need to make sure to include it in the schema validation in the same way we do for C01 project pages.

Overall great job!

[wgwz]

I also noticed that we don't have in here a section for media or project photos. I'm sure this is being automatically populated in the user-interface, we just need to make sure to include it in the schema validation in the same way we do for C01 project pages.

@S4mmyb we have previewPhoto and galleryPhotos fields (same fields as C01) for both of the two projects i've written the metadata for so far.

  "regen:previewPhoto": "https://regen-registry.s3.amazonaws.com/projects/C02/harvey-manning-01.jpg",
  "regen:galleryPhotos": [
    "https://regen-registry.s3.amazonaws.com/projects/C02/harvey-manning-02.jpg",
    "https://regen-registry.s3.amazonaws.com/projects/C02/harvey-manning-03.jpg"
  ],

[wgwz]

todo: remove the regen:cfcProjectId

[S4mmyb]

@wgwz I just gave this a final review and it all looks good! Changes/updates I made:

• Small tweaks on content (project location lat/lon, descriptions, etc...) to better reflect what CFC has on their project pages + adding dates/offset protocols to the projects which didn't have them
• Changed batch file names for the batches we plan on issuing first to reflect the format seen on the ledger: <creditClassID-projectID-batchStartDate-batchEndDate-batchID. Note I used the start and end dates in the verification report as the batch start/end dates.
• Added project verifier to the C02 batches. I updated the shacl shema, json, and ops files to reflect this using the NameURLShape and ran the validation script and everything conformed (yahoo!)

I'll go ahead and approve this, but before we merge we just need to make sure to add in the project start/end date to the King County project (C01-001) which is missing from the project design document. I emailed the CFC team to get those dates - once we have them all we need to do is fill them in and make sure it successfully conforms to the shape as it's currently failing on invalid date format (ie we don't have a date).

Once again, great work!

[S4mmyb]

Added in the final dates for the final C02 project C02-001 and all checks on the shacl-validate have passed so approving now cc @wgwz