Skip to content
This repository was archived by the owner on Sep 25, 2025. It is now read-only.

Update database schema image - #70

Closed
francocorreasosa wants to merge 1 commit into
masterfrom
update-schema-image
Closed

Update database schema image#70
francocorreasosa wants to merge 1 commit into
masterfrom
update-schema-image

Conversation

@francocorreasosa

@francocorreasosafrancocorreasosa commented Oct 17, 2019

Copy link
Copy Markdown
Member

Closes#54 (till we change the schema again)

@allella

Copy link
Copy Markdown
Contributor

@francocorreasosa I think #46 agreed to changing group(s) to chapter(s), so that may be a change on the diagram.

There was a desire to normalize the vocabulary of higher-level things in #61 and "group(s)" is pretty vague and folks liked using the core chapter(s) entity in its place.

@francocorreasosa

Copy link
Copy Markdown
MemberAuthor

@allella I could try to keep it updated as soon as changes are introduced to master. Maybe not with every change but periodic checks and updates should do it.

This image was generated using dbdiagram.io (also in the image for reference), so I would expect any PR that changes the schema to have the updated image too, since the tool required to update it is free to use and available online.

@nik-john

Copy link
Copy Markdown
Contributor

@francocorreasosa could you point the PR to https://github.com/nik-john/chapter instead? I was looking for the updates ER diagram anyway and have updated the SQL file so it makes sense to combine the two

@f0cus10

Copy link
Copy Markdown

At one point we should automate this image generation process. A GitHub bot maybe?

Something that will automatically issue a PR when the schema is changed. Of course, that depends on how frequent we can expect the schema to change.

@allella

Copy link
Copy Markdown
Contributor

@francocorreasosa I asked on #54 if @dmmulroy could generate a new ER Diagram with one of the open-source tools he mentioned. Pinging you in case you have input on it and/or want to share the tool you used for this now outdated image.

@allella

Copy link
Copy Markdown
Contributor

Well, I see dbdiagram.io in the corner, so mystery solved on that part.

@xarielx

xarielx commented Oct 18, 2019

Copy link
Copy Markdown
Contributor

Should we incorporate something like a live link of the dbdiagram?
We can update this much easier.
https://dbdiagram.io/embed/5da9492502e6e93440f25b41

@allella

allella commented Oct 18, 2019

Copy link
Copy Markdown
Contributor

I like the idea, since then the diagram is also interactive. It might not fit perfectly inside of the viewport, but there's a zoom in/out in the tool. @chrismgonzalez@vkWeb are there any issues with dropping iframes in Github docs?

@matjack1

Copy link
Copy Markdown
Contributor

Look at this diagram:

chapter-er

Made with DBeaver: https://dbeaver.io/ which is free, open source and multiplatform, meaning that anyone can update this :)

If you like it I can set up a small guide on how to generate these (it's very quick).

@vkWeb

Copy link
Copy Markdown
Member

[...] are there any issues with dropping iframes in Github docs?

@allella No we can't do that. GitHub doesn't allow putting iframes in .md files. :(

We can manually update it for some time as we evolve the API, after a period of time, I don't think we'll be changing the db schema so we don't necessarily need to automate it.

Let's update the image and merge this. What do you say @francocorreasosa?

@jamesarm97

Copy link
Copy Markdown

With the events in the DB, will there be a cost or some sort of fee variable? Right now in the schem shown above there are none, or is that just a starting point? Some sort of re-occurring field and when it will end.

@wuilliam321

Copy link
Copy Markdown

We can keep the PR open, until we have a very stable diagram. No need to merge it now, what do you think. It allows us to track all the progress.

@matjack1

Copy link
Copy Markdown
Contributor

I think we should settle on deciding which tool to use (I'm proposing DBeaver as it's a OSS cross/platform tool to let everyone update the picture without any account sharing need).

And then I agree with #54 (comment) to link directly the https://github.com/freeCodeCamp/chapter/raw/master/data/schema.png in the README.md, so that we can simply update the picture at later stages.

If you agree I can open another PR for this? @francocorreasosa what do you think?

@allella

Copy link
Copy Markdown
Contributor

I like the DBeaver image over the others I've seen, so +1 from me on it. Also, +1 for linking to the raw image URL in Readme.

@bernhard-hofmann

Copy link
Copy Markdown
Contributor

The diagram is out of date now. If you could update it I'll happily merge this PR.

@matjack1matjack1 mentioned this pull request Oct 22, 2019
3 tasks
@matjack1

Copy link
Copy Markdown
Contributor

Since this PR wasn't getting feedback I've opened a new one here: #129

Feel free to close it if this one is updated.

@allella

Copy link
Copy Markdown
Contributor

Closing this as #129 did the trick and included updating the README image path.

@allellaallella closed this Oct 22, 2019
@allella

Copy link
Copy Markdown
Contributor

@francocorreasosa I'm seeing this was a local update-schema-image branch and not a fork branch. I suspect we can delete that branch, but I'll defer to you on it.

@francocorreasosa

Copy link
Copy Markdown
MemberAuthor

@allella Yes indeed, deleted.

@francocorreasosa
francocorreasosa deleted the update-schema-image branch October 23, 2019 01:39
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Schema image / ER Diagram is out of date

10 participants

@francocorreasosa@allella@nik-john@f0cus10@xarielx@matjack1@vkWeb@jamesarm97@wuilliam321@bernhard-hofmann