OSHW Dashboard: Difference between revisions
Jump to navigation
Jump to search
| Line 18: | Line 18: | ||
=Example from Website= | =Example from Website= | ||
<html><iframe src="https://docs.google.com/document/d/1SIvmrkY9z1e-NIHGK25xkkWn2WuFMmS3u-fV3YOlZnE/pub?embedded=true" height= | <html><iframe src="https://docs.google.com/document/d/1SIvmrkY9z1e-NIHGK25xkkWn2WuFMmS3u-fV3YOlZnE/pub?embedded=true" height=600 width=500></iframe></html> | ||
=Procedure= | =Procedure= | ||
Revision as of 17:48, 8 January 2016
These are the essential metatags and metadescriptors to be incorporated into documentation of open hardware projects:
- OSHW – The tags that identifies the entire project as open source hardware
- Entity – The person or organization responsible for the project
- Project Name – Something unique that identifies the specific project
- Version – An alpha-numeric code that increments at milestones
- Completion Status – The general maturity level of the project
- Version Date – Last time the version number changed
- Terms of Use – Any terms of use or licensing compatible with the latest version of the open source hardware definition
- Summary – The project pitch – short (140 characters?)
- Keywords – A comma separated list of synonyms – tags for search engine optimization
- Description – The detailed description of the project
- Predecessors – This project descended from…
- Content Location – A URL to the main project repository
This is a standard proposed as a result of the Open Source Hardware Documentation Jam of 2013.
Example from Website
Procedure
We welcome.other projects to copy this dashboard and post their information on the OSE wiki. To do so, start a page named OSHW-YourOrganization-YourProjectName-Version on this wiki after you register for an account.
External projects and OSE projects are encouraged to use the above tags such as OSHW-OSE-CNC_Torch_Table-v1 and so on.
The template for this needs to be built to facilitate entries, under Wiki Templates.