usnistgov / pfhub

The CHiMaD Phase Field Community Website
https://pages.nist.gov/pfhub
Other
49 stars 40 forks source link

Add CODEMETA.yaml #1426

Closed wd15 closed 2 years ago

wd15 commented 2 years ago

Address #1319

A comment will appear below when the live site is built. This normally takes a few minutes.

Remember to tear down the live site when merging or closing this pull request.

pfhub commented 2 years ago

The new PFHub live website is ready for review.

wd15 commented 2 years ago

@tkphd, the CODEMETA.yaml needs colons for all the sub-lists.

wd15 commented 2 years ago

@tkphd, this ,

--- 
- hello1
  #
  - hello2

isn't valid yaml according to this, but this is,

--- 
- hello1:
  #
  - hello2

YAML isn't markdown I guess. Point being the list needs to be part of a key-value pair.

pfhub commented 2 years ago

The new PFHub live website is ready for review.

tkphd commented 2 years ago

Good info, @wd15 -- thanks! NIST apparently uses tags from GitHub repositories, not CODEMETA.yaml, to sort code into the "right" category. Indeed, CODEMETA.yaml is never actually used, which might explain why invalid YAML might have been overlooked for this long.

While this CODEMETA looks good to me, I do not believe it should be merged into this repository, as the whole YAML-based categorization framework is work-in-stagnant-progress.

wd15 commented 2 years ago

Good info, @wd15 -- thanks! NIST apparently uses tags from GitHub repositories, not CODEMETA.yaml, to sort code into the "right" category. Indeed, CODEMETA.yaml is never actually used, which might explain why invalid YAML might have been overlooked for this long.

While this CODEMETA looks good to me, I do not believe it should be merged into this repository, as the whole YAML-based categorization framework is work-in-stagnant-progress.

Not to worry then. I'll close this and #1319