Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Precisions in okh-manifest.yml model needed + Fr template/translation proposal #39

Open
Villafruela opened this issue Jul 26, 2020 · 5 comments

Comments

@Villafruela
Copy link

Villafruela commented Jul 26, 2020

Hi,

In the template of okh-manifest.yml file described in the standard, i think some items should be explained in more details. For instance :

  • affiliation should be defined more clearly. What does it represent ? Is it the name of the group, company, non profit group you may be part of or something else ?
  • Also the difference between derivative, variant and sub should be defined more clearly to help users dissociate the different cases (if you've made a slight change on a project is it a derivative or a variant ?).
  • At the begenning of the file, a comment explaining that if you have several items to specify, you can multiply the entries. For instance if you have several design files, you can add :
  • path: [value]
    title: [value]
    several times, one for each file.

Maybe :

  • a difficulty level could be added in the standard parameters in order to know if building the project is easy, medium, hard or very hard
  • a skill list required to build the hardware could also help (like 3D printing, soldering, electronics, laser cutting etc.). This would help identify the kind of knowledge needed to build the hardware and what you need to learn to fulffill the construction if you lack one or several skills.

We've translated okh-manifest.yml template in french here
We've also made a tutorial in french to explain how to use the OKH standard here.
We're also willing to translate the OKH standard in french if you need. Just let us know...

Nemo

@amchagas
Copy link
Member

Hi @Villafruela

Thanks for your input, translating the manifest, and creating a post in French to explain it!

Maybe it would be good to plug these translations into the main OpenKnowHow page as well as the form we have for creating manifests? what do others think? @kasbah @dubsnipe @julianstirling @rafaellaantoniou?

@julianstirling
Copy link
Member

julianstirling commented Jul 27, 2020

It is worth asking @pciavald if the manifest creator will generate an updated form based on this file. If I remember correctly it uses the comments to generate the form.

I think the right place for the translations would actually be with the spec, so that it can be kept in sync. We can then serve copies from the web-page. Something that we cannot do while it is in StandardsRepo...

@rafaellaantoniou
Copy link
Member

rafaellaantoniou commented Jul 29, 2020 via email

@pciavald
Copy link
Member

pciavald commented Jul 31, 2020

Hi,

@Villafruela unfortunately the standard that you've translated is not the latest version, it has been adjusted since the one you've taken as a base. Here's the latest version.

The manifest form is based on this file and we could imagine that the syntax is modified to something like this:

  *title <en:Name of the hardware; fr:Nom du matériel>: string;

@Villafruela
Copy link
Author

I've made the modifications (not yet on our site) and proposed them on the repository. I can translate the rest of the assets files if you like, or anything else if you need, let me know. Once the files will be available i'll change our tutorial to match the last version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants