Giter Site home page Giter Site logo

Comments (3)

sjkp avatar sjkp commented on July 17, 2024

I have not much experience with building something like this myself, but have used mermaid docs before. One thing I find problematic with auto generated diagrams however is the layout of them. A lot of readability in a diagram comes form the placing the elements in the correct reading order, left-> to -> right or top -> down organized in some meaningful manner, so if you are going full automate on diagram creation I would suggest that you at least add some manual knobs to turn the layout.

from atc-dataplatform.

LauJohansson avatar LauJohansson commented on July 17, 2024

I like this idea. Of course, it gets more "boring" layout (less flexible), BUT we can ensure that our documentation actually contains the classes that we use. The automatic creation of the diagram will remove the manual process of updating it. Furthermore, we use the same symbols and often the ETL process uses the same direction - therefore it is obvious that exactly this can be automated.

from atc-dataplatform.

mrmasterplan avatar mrmasterplan commented on July 17, 2024

Automatically created diagrams are always going to be ugly. I have abandoned this work.

Another way could be to go the other way round,

  • define a grammar for how drawio diagrams relate to code and then unpack the drawing to check consistency with some markup...

But really. The only kind of diagram that people will consistently update is a diagram that is functional. I therefore think that the best thing to use for now is Databricks' task-orchestration. I will now close this issue. Please use task orchestration if you have not tried it already

from atc-dataplatform.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.