Git Product home page Git Product logo

Comments (3)

leif81 avatar leif81 commented on June 26, 2024

@brutzman @terry-norbraten are either of you familiar with the plan for the dis-tutorial repository? It appears like @mcgredonps was the primary author (based on number of commits) but there were a number of contributions from others.

I see that there is a tutorial written within the git repo markdown pages and another in the git repo wiki pages. Was it intended to be the same tutorial? Is one version newer than the other? From the dates of changes it's not obvious to me, the two copies appear to be authored roughly in parallel between 2017 and 2019. But there are significant differences between the two copies.

The git repo markdown pages were authored between Jan 2, 2017 and Jan 9, 2019 .

Whereas the wiki pages were authored between Oct 28, 2017 and March 12, 2019

My thought is it would be nice if could consolidate the two tutorials (if indeed they were intended to be one tutorial), but I don't have enough background to understand if we should straight up delete one copy and keep the other or how to proceed.

from dis-tutorial.

terry-norbraten avatar terry-norbraten commented on June 26, 2024

from dis-tutorial.

brutzman avatar brutzman commented on June 26, 2024

There is a lot of good information in the tutorial, but it never reached fruition as a useful (recommendable) document.

We have no funding or expert availability to pursue the tutorial this year, though we do aspire to work on DIS 8.

If we might structure the tutorial information in an XML document that corresponded to PDUs and abstract classes, plus other things, then we would be able to integrate it into our code autogeneration as Javadoc, python comments, C++/C# documentation, etc. I've done this kind of thing before to good effect.

Divide-and-conquer suggestion: why don't we integrate pertinent parts directly into the XML that captures DIS7, meaning that much of it could eventually port to DIS8 autogeneration when we get there. Specifically, changing the @comment attribute (found in current XML) into @description (terse form) and @explanation (tutorial detail) might provide space to put a lot of the material into context, providing a good start on such refactoring.

This is a good project for someone that could encourage a number of contributions. Design is key. I'd expect that the SISO working group would let us apply blocks of prose freely since we would not be violating IEEE copyright.

from dis-tutorial.

Related Issues (7)

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.