Making OnShape document available on GitHub

hank_debey

I want to publish our design as an Open-Source project but I have some questions.

The design is for a negative-pressure, externally-applied ventilator for use in developing countries.

I think we need to create a GIT repository. To make our OnShape design available on GitHub should we convert our OnShape design to some other format or just stick with OnShape?

If a person wants to access our OnShape share link, do they need to register for OnShape to access the design that it is linked to?

Can people on this forum offer tips on what we should do to effectively publish our design?

Hank

tim_hess427

Make the document public, then just share the URL however you'd like (github or where ever else you like). 

Keep all the edits on Onshape - there's built-in version control, branching and merging, as well as a system for commenting within an Onshape document. Things would get much more complex if you try to export stuff into a different format. If the project is public, anybody can create a free account and collaborate. You can even upload any other type of file you want into the onshape document (such as specification documents, design plans, etc...)

Depending on the structure of the project, it may make sense to split the whole project into multiple documents, in which case, the value of github may be in coordinating the overall project structure. 

NeilCooke

hank_debey said:

tim_hess427 , can you recommend a resource for learning more about OnShape's built-in version control?

There are several resources at https://learn.onshape.com such as:

https://learn.onshape.com/courses/fundamentals-document-history-and-versions
https://learn.onshape.com/learn/article/understanding-and-working-with-a-documents-historical-data

tim_hess427

Make the document public, then just share the URL however you'd like (github or where ever else you like). 

Keep all the edits on Onshape - there's built-in version control, branching and merging, as well as a system for commenting within an Onshape document. Things would get much more complex if you try to export stuff into a different format. If the project is public, anybody can create a free account and collaborate. You can even upload any other type of file you want into the onshape document (such as specification documents, design plans, etc...)

Depending on the structure of the project, it may make sense to split the whole project into multiple documents, in which case, the value of github may be in coordinating the overall project structure. 

emagdalenaC2i

GitHub may be an interesting tool with other CAD systems (tradicional CAD systems based in files) but not with Onshape
Git or GitHub is a great tool to handle files, but there are no "files" in Onshape

hank_debey

tim_hess427 , can you recommend a resource for learning more about OnShape's built-in version control?

NeilCooke

hank_debey said:

tim_hess427 , can you recommend a resource for learning more about OnShape's built-in version control?

There are several resources at https://learn.onshape.com such as:

https://learn.onshape.com/courses/fundamentals-document-history-and-versions
https://learn.onshape.com/learn/article/understanding-and-working-with-a-documents-historical-data

emagdalenaC2i

And there are a few webinars of @NeilCooke
https://www.onshape.com/videos/managing-design-teams-collaboratively-with-github-style-branching-and-merging-07-03-18
https://www.onshape.com/videos/managing-complex-design-projects-with-git-style-branching-merging-101719