Clarify some metadata and update optional/required/recommended status.

Review Request #11732 — Created July 19, 2021 and submitted

Information

DiffX
master

Reviewers

This updates the definitions and examples for some of the metadata,
making it more clear how some are used and what values are expected.

Some of the required keys are now marked as recommended instead, since
it doesn't always make sense to include them. "Required" show now be
used sparingly.

The file stats metadata key is also now recommended, instead of merely
optional, as it's a very useful thing to include if available for
statistics information.

Built the docs. Read through the new changes. Checked the links for
errors.

Summary ID
Clarify some metadata and update optional/required/recommended status.
This updates the definitions and examples for some of the metadata, making it more clear how some are used and what values are expected. Some of the required keys are now marked as recommended instead, since it doesn't always make sense to include them. "Required" show now be used sparingly. The file `stats` metadata key is also now recommended, instead of merely optional, as it's a very useful thing to include if available for statistics information.
4b71cdf679f727bc6fc4bf297eaebe7f0f760018
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to master (08fb590)
Loading...