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

Add individual user fields for privacy policy and terms of service #5

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

robvenn
Copy link
Member

@robvenn robvenn commented Jul 25, 2020

@Naraujo13 just creating a draft PR with 2 extra fields as I have some questions about the data model workflow
when making changes, like I did here, which steps should be taken?

It seems like Hackolade automatically updates the lastModified and version information
I just clicked "save" and committed everything into git but this seems like a bunch of unrelated fields were also automatically updated

And the images / PDF output of the data model should probably also be updated every time when the model changes?
It might be useful to do one or both of these things to make it easier for contributors to help out with this:

  • add more specific upgrade instructions in the README
  • automate the process with a script (or maybe Hackolade already provides this)

@Naraujo13
Copy link
Member

Naraujo13 commented Jul 26, 2020

Hi @robinv85

Hackolade automatically updates the lastModified and version, but it is indeed hard to keep track of changes from the project JSON file.

It is easier if you generate the scripts and documentation again. Trough the forward engineering menu, you can automatically generate JSON schema files, JSON examples of documents for each collection, Mongo and Mongoose scripts.
Those are way easier to track the changes and we should always generate them when making changes to keep them up to date and to be able to track the changes.

Anyway, the main flow is making the change on the project and then generating scripts + docs (HTML and PDF) automatically from Hackolade.
The images are exported from Hackolade too, but you need to manually choose what to export and etc, so I did this part manually until now.

A script that does all of this would be nice, but I don't know if they offer these features in a non-GUI interface.
And yeah, you're right, this kind of thing needs to go to the README, so an update/contribution guideline is a good idea.

I'm not sure I can create this right now, but I can help and review it if you want to go ahead.
Otherwise, I will try to tackle this when I get some extra time in the future.

@Naraujo13
Copy link
Member

Also, I can review this PR if you want.
Could you please generate the update scripts?
This way we can see the diff in the json docs and schema, mainly,

@Naraujo13 Naraujo13 added the enhancement New feature or request label Jul 26, 2020
@robvenn
Copy link
Member Author

robvenn commented Aug 24, 2020

Hey @Naraujo13 it seems like these 2 fields belong for both the individual and organizations.
I looked at updating the generated scripts as well, but it seems to generate a different, incorrect Mongoose schema file, and also the names for the folders seem to be different, any idea if this could be a different version or configuration in the software?

@robvenn robvenn marked this pull request as ready for review August 24, 2020 20:13
@Naraujo13
Copy link
Member

The folder names are really generated with different names.
For some reason, Hackolade put spaces and bugs everything, so I changed that manually before 😅

The Mongoose schemas generated here are just raw versions, unfortunately, just fields and some validation, the rest we've manually added to the models.

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

Successfully merging this pull request may close these issues.

2 participants