OpenChain-Project / Online-Self-Certification-Web-App

This is the source code for the OpenChain Project Conformance Online Self-Certification Web App
https://certification.openchainproject.org/
Apache License 2.0
12 stars 5 forks source link

OpenChain Self Certification Questionnaire text - Strange Formatting #68

Open shanecoughlan opened 5 years ago

shanecoughlan commented 5 years ago
screen shot 2019-01-16 at 16 32 41

There is an issue with the way questions are presented title + bullet points. We need to resolve this for clarity.

Instead of the current solution perhaps we can fold text into each question.

e.g. not:

Do you have FOSS training materials (e.g., slide decks or online course) covering the following topics?

  | YesNo |   | The FOSS policy and where to find it,   | YesNo |   | Basics of Intellectual Property law pertaining to FOSS and FOSS licenses,

But instead:

  | YesNo |   | Do your open source training materials cover your open source policy and where to find it,   | YesNo |   | Do your open source training materials cover the basics of Intellectual Property law related to open source licenses,

This solves formatting and makes things easier for non-native speakers in the Far East.

http://openchain-env.m6rqmtrixp.us-west-1.elasticbeanstalk.com/survey.html

goneall commented 5 years ago

Changing the text would need to be done in the conformance-questionnaire repository.

If we remove the text for the top level question (e.g. no longer display "Do you have FOSS training materials (e.g., slide decks or online course) covering the following topics?"), we would need to make some changes to the application.

This would also impact the PDF file generated.

Note - subquestions are scored with X number correct out of Y questions, so they still need to be grouped.

There is some complexity and risk associated with the proposed approach.

@shanecoughlan Should we continue to display the top level question?

Should we fix this prior to translation?

If so, I am thinking we need to setup some time to discuss the approach and implications of this solution to make sure we don't break something while fixing the formatting for this.

theopenchainproject commented 5 years ago

In #66 you mentioned something about the Section titles that I want to swing back to:

"The leading section "G1" has been removed and will be available next time we update the site. The second "G1" is in the conformance-questionnaire repo. We would need to remove the G1 from each of those sections. Personally, I like the format "G1: Know your FOSS responsibilities" as it gives you a section reference you can use to refer back to the specification."

Understood, and we can continue this as long as the Spec uses G1, G2 etc. It may change with the new revision in April.

For the other item, it sounds like we should continue to display the top level questions and address this another time. We can swing by after the 1.0 release of this web app and address the matter.

goneall commented 5 years ago

@shanecoughlan and I discussed and we can resolve this with an update to the questionnaire data. We can change all of the subquestions into direct questions. At a later date, we can work on the formatting to improve subquestions if we run into a situation where not all of the subquestions need a positive response for completion.

Note: As of version 1.3 - all subquestions need a positive answer for the question to be complete.