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

New organization of project resources #82

Closed
icarofonseca opened this issue Mar 15, 2019 · 2 comments
Closed

New organization of project resources #82

icarofonseca opened this issue Mar 15, 2019 · 2 comments

Comments

@icarofonseca
Copy link
Member

I want to propose a new organization for the project's online resources. It will be as follows:

  • This repo will be used only for development of the Vessel.js build files.
  • A second repo will host the Vessel.js website with all other library resources (examples, ship specifications, STL files, research papers).

Advantages as perceived by me:

  • More organization in the resources: the examples folder in this repo is becoming crowded and will become heavier as we aim for more detailed STL models.
  • Less entanglement in the development of examples: we will be able to carry development of the main library without being concerned whether it maintains supports to all the examples we developed so far. The examples will be stored in the second repo with the builds used to develop them by the time.
  • Better support to the development of our website: the second repo can be used to host the Vessel.js website with GitHub's own "pages" feature, making the current server unnecessary, at least for now (see it in action here). It also provides version control (something our current solution Cyberduck does not, as far as I know) and supports assigning our custom domain (i.e., vesseljs.org) to the page hosted in the repo.

Additionally, @DiogoKramel and I have been working on a script that will allow users to download a .zip with the source files of an example. You can test a prototype here.

@EliasHasle
Copy link
Collaborator

The second point is a good one. And so is the proposed solution, I think. But again, there is a lot of reuse in the examples too. Reuse of code for generating ship models and ocean environment. Should that be duplicated for each example too? I suppose it would have to, for unmaintained examples. But there should still be a "canonical" version of each script.

@icarofonseca
Copy link
Member Author

Yes, you are right, there is much interdependence between examples and the snippets such as Ship3D, oceans, etc. In practice what is happening now is that they are being duplicated inside the examples folder. In the future, we may find a better solution to handle this.

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

No branches or pull requests

2 participants