opulo-inc / lumenpnp

The LumenPnP is an open source pick and place machine.
Other
2.41k stars 321 forks source link

[DOCS] License for the documentation #243

Closed darigovresearch closed 1 year ago

darigovresearch commented 3 years ago

Various open source projects have different licenses for the product itself and the documentation. Often it's a CC-BY or other creative commons license for the documentation where the code and hardware is under a different suitable software license. We couldn't find any for the docs themselves. Depending on how you've built them you can autogenerate a link to the license at the bottom of each page.

Have you thought on this topic and if so which licenses were you considering?

Having an explicit license may mean you will get more open source contributions to the docs by the open source hardware and open source software community.

daveismith commented 3 years ago

Currently my understanding is everything is licensed under GPL3, but it's probably something that should be reviewed to make sure that it's correct. I know for example that typically hardware uses different licenses such as CERN OHL (see this blog post blog post). You also raise a good question about doc licensing.

I've assigned this to @sphawes to review and make a decision. Once he's either confirmed GPLv3 or something else I can update the docs to add that info at the bottom of the generated pages.

darigovresearch commented 3 years ago

@daveismith great point, some more mature open source projects have three licenses which may apply here

Examples of good similar open source projects which do this well are

The above have the same kind of components you have, PCB designs, STL/CAD models and software so you may find some benefit from seeing what they did.

I think this issue is quite an important issue as from experience depending on the license chosen correlates to the number of community contributions and the longevity of the project as a whole

Happy to discuss if we can be of any assistance

darigovresearch commented 3 years ago

For the record, happy to put our contributions under whatever license you choose in the end!

The earlier this is decided & made explicit, the more likely you will prevent issues like https://github.com/openpnp/openpnp/issues/1163 of having contributions which aren't under a unified license

sphawes commented 2 years ago

We'll be moving the docs to a separate repo than the source shortly, and we'll make sure to have a dedicated license for them! Thanks for bringing this up @darigovresearch! I'll close this once that happens.

darigovresearch commented 2 years ago

You're very welcome & sounds good!