Skip to content

Commit ecc5898

Browse files
committed
embed bare links into the text as markdown
1 parent 83cf068 commit ecc5898

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

content/en/standards/documentation/_index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,19 @@ We suggest three main categories of documentation:
3535
### General Metadata
3636
- Name and version of the model
3737
- Model project page (organizational website or repository, if available)
38-
- Description of the model, including its purpose or goals and the type or formalism of the model (e.g., system dynamic, agent based model, machine learning), preferably accompanied by relevant keywords
38+
- Description of the model, including its purpose or goals and the type or formalism of the model (e.g., system dynamic, agent based model, machine learning), preferably accompanied by relevant keywords
3939
- Name(s) and contact information of the developer(s)/author(s)
4040
- Date of release
41-
- OSI-approved license https://opensource.org/licenses
42-
- How to cite the software
41+
- [OSI-approved license](https://opensource.org/licenses)
42+
- [How to cite the software](https://www.force11.org/software-citation-principles)
4343
- Location where the model is posted or published (e.g. PID or DOI)
4444
- Computer language or platform used for programming
4545
- Software and/or hardware requirements needed to run the model and replicate any published results
4646
- All data dependencies needed to run the model and replicate any published results
4747
- Information on how to install the model so that it can be run (e.g., compilation and/or execution instructions)
4848
- Use cases: References to reports or publications where the model is used
4949
- Changes since the last version (if the model is an update) including bug fixes, new features, or other substantive modifications, where appropriate.
50-
- compliance with codemeta (?) https://codemeta.github.io/
50+
- [Harmonization with schema.org and codemeta metadata vocabularies](https://codemeta.github.io/)
5151
- Development status (e.g., experimental, deployed, peer-reviewed, ...)
5252
- Funding sources
5353

@@ -86,14 +86,14 @@ We suggest three main categories of documentation:
8686
- Links to open access resources
8787

8888
## Ideal Documentation Standards
89-
- ODD Protocol for Describing Agent-Based and Other Simulation Models (see http://jasss.soc.surrey.ac.uk/23/2/7.html)
89+
- [ODD Protocol for Describing Agent-Based and Other Simulation Models](http://jasss.soc.surrey.ac.uk/23/2/7.html)
9090

9191
## Cyberinfrastructure and Tools for Implementation of Documentation Standards
9292
- Cross-links between documentation sections
9393
- Bibliographic documentation / management system (e.g., Mendeley links)
9494
- Tagged content management system entry form (linkage between sections)
9595

9696
## Examples and References for Documentation
97-
97+
- TBD
9898

9999

0 commit comments

Comments
 (0)