Appropedia:OSHWA Certification tool design/Documentation

This tool will help you obtain an open hardware certification by a project or device page on Appropedia. Check the OSHWA Certification page for more details.

How it works[edit | edit source]

This tool will analyze the metadata provided on the databoxes. A well-formed page will serve as the documentation endpoint. This means:

All information must be available as part of the documentation page.
External links to documentation resources on other pages are encouraged. This includes content such as digital fabrication files, tool settings, images and other material hosted on platforms such as GitHub, GitLab, Thingiverse, etc. However, links to personal hosting services (i.e. Google Drive or Dropbox) should not be provided. The certification tool will request metadata available through Appropedia's API page. You will have to provide further information before making your submission.

Requirements[edit | edit source]

Page must be well documented through the use of the Databox templates: Template:Page data, Template:Project data and Template:Device data.
An open license must be selected for each of the components. Appropedia recommends the CC-BY-SA-4.0 license for documentation, CERN-OHL-S for hardware and GNU GPL licenses for software.

Change requests[edit | edit source]

Show stepper (e.g. "step 1/4", "step 2/4").
Home page should ask for either a URL or a page name as a complementary function to what is in place now.
Add a second page after "yes, validate" to stage the information to be submitted. It could be a table that shows the parameters available and whether any parameters are missing. Show the following message: "This is the available data for this page. Please ensure the data below is correct or make any changes to the page before continuing to the next stage of the certification tool". Add buttons "Continue" and "Make changes" linking to https://www.appropedia.org/w/index.php?title=PAGETITLE&action=edit
Change "use the default options" to "use the recommended options".
Leave the "I agree to the terms of the OSHWA certification" item on a page of its own to ensure that users actively review it. Add a link to the agreement terms and the user guidelines, please!

Example[edit | edit source]

Step 0

Step 1

Step 2

Step 3

File:Step 0

Initial prompt

This tool will guide you through the process of submitting your documentation for the OSHWA certification. Please see this tool's documentation to help you prepare your documentation before submitting as well as OSHWA's terms of service.

File:Step 1/3

Staging

You have selected the page 3D_printed_bike_pedal for certification. This is the information available:

responsiblePartyType: "Organization", // "Western University"
responsibleParty: affliations, // "FAST"
bindingParty: bindingParty, // "Jack Peplinski"
country: country, // "Canada"
projectName: title, // "3D_printed_bike_pedal"
projectWebsite: url, // "https://www.appropedia.org/3D_printed_bike_pedal"
primaryType: primaryType, // "3D printing"
hardwareLicense: "Other", // "Other"Hardware license missing or not entered correctly
softwareLicense: "Other", // "N/A"
documentationLicense: "Other", // "CC-BY-SA-4.0"

Is this information okay? If not, please return and edit the required parameters. Please refer to the documentation page on Appropedia.

Data is correct. Continue certification Edit page

File:Step 2/3

Certification-specific information

This will show the form minus the final item.

File:Step 3/3

OSHWA Certification Agreement

I agree to the terms of the OSHWA Open Source Hardware Certification Mark License Agreement, including the Requirements for Certification and Usage Guidelines incorporated by reference and including license terms that are not present in or conflict with this web form. I acknowledge that by agreeing to the terms of the OSHWA Open Source Hardware Certification Mark License Agreement that I am binding the entity listed to the License Agreement. I recognize that I will receive my unique identification number that allows me to promote my project as OSHWA Open Source Hardware Certified in compliance with the user guidelines via the email provided to OSHWA after submitting this form.

Submit

Troubleshooting[edit | edit source]

Attribution[edit | edit source]

Attribution on Appropedia is provided through Template:Page data and Template:Project data. Please note that project authors are the ones who built a device or participated on a project, whereas documentation authors are the persons who contributed to write the documentation. Check the following:

Documentation authors' user names have been provided to the authors parameter on Template:Page data (with the User: prefix) and the authors' user pages contain the Template:User data template and correct attribution names have been provided. Otherwise, you can override this functionality by providing the full attribution names.
Project participant names are provided to Template:Project data.

Licensing[edit | edit source]

An open-source-compliant license has been granted to the project.

Check that a license such as CC0 or GPL must be provided for software in case your design contains any sort of firmware.
A hardware license must be provided.
As a default, all documentation on Appropedia is shared under a CC-BY-SA-4.0 license.