search

polypheny / Polypheny-DB

A self-adaptive Polystore that provides cost- and workload aware access to heterogeneous data.
https://polypheny.org
Apache License 2.0
124 stars 83 forks source link

Railroad diagrams for SQL syntax diagramms #290

Open vogti opened 3 years ago

vogti commented 3 years ago

Railroad diagrams are a nice way for visualizing a syntax. It would be nice if we could also integrate railroad diagrams into the Polypheny website.

I found the JS library rrdiagram-js which allows generating such diagrams, but we need to integrate this into the template of our website. It would be good if the BNF source for generating a diagram is not in an extra file but embedded into the markdown file. The BNF source should then be automatically be replaced by a diagram.

harivansh0 commented 3 years ago

Hi! I am HariVansh, To start with my contribution to the community I want to work on this issue. Is it available? If so, could you please assign me it? Thank you.

vogti commented 3 years ago

Hi @harivansh0, welcome to Polypheny! It would be great if you can take care of this issue. I have just assigned it to you. I think the best approach is to fork the website and set up a private deployment. Do you have experience with Jekyll?

harivansh0 commented 3 years ago

I will learn Jekyll. I have set up a private deployment. Can you guide me on where to start from?

vogti commented 3 years ago

I think the best approach is to write a Jekyll plugin which replaces a block with BNF by a railroad diagram using the JS library linked above. But you need to look into how to exactly to this. Unfortunately, I can't guide you through writing a Jekyll plugin, as I have never done that myself either.

harivansh0 commented 3 years ago

Okay, No problem. I will try to figure it out.

AyushKadwe commented 3 years ago

Hi, I would like to work on this issue , can you suggest me the proper ways to get started ?

vogti commented 3 years ago

Hi @AyushKadwe, @harivansh0 is already working on this problem. However, you can select another problem from the list. If you have experience with Jekyll, you can also ask @harivansh0 if he would like to work together with you on this issue. The issue can easily be split into two parts. But it is @harivansh0 decision.

vogti commented 3 years ago

Hi @AyushKadwe, hi @harivansh0, is everything working fine? If you have any issues or need help getting started, please do not hesitate to either ask here or open a thread in the discussion forum.

harivansh0 commented 3 years ago

Hi vogti, Actually I am having my final semester exam.That why Development is slow.

vogti commented 3 years ago

I wish you all the best for your exams. Please remember that the deadline for submitting proposals through the GSoC platform is in a few hours. If you have any questions about drafting your proposal, please send us a mail (mail (at) polypheny.org).