Proposal to add `buildInstructions` in schema.orgSee original GitHub issue
During the last few months we have reviewed the additional 10 properties that aren’t in schema.org and are only in CodeMeta,
buildInstructions is one of these properties.
The definition used on CodeMeta is:
link to installation instructions/documentation
Documentation is a main part in software development and is crucial in the understanding of the software and its functionalities. There are different types of documentation:
- user manual
- build instructions
Therefore, when describing a software project or artifact with metadata it is useful to have access to its documentation and its build instructions.
In the crosswalk table at the moment this property isn’t used and it might be more appropriate to rename
documentationUrl before submitting the issue to schema.org.
Another option is to have both metadata properties (which are different).
- Created 3 years ago
- Comments:20 (10 by maintainers)
Top GitHub Comments
I’ve closed my PR so there can be more discussion on how to implement this.
My vote would be to try and standardize on
buildInstructionsin the long run for two reasons:
buildInstructionsis just one example of a possible many subsets of a
documentationproperty. So if we want to go in that direction, we should probably think about others.