Coder Social home page Coder Social logo

Comments (3)

wbamberg avatar wbamberg commented on April 28, 2024

Yes, we've talked about this and agreed that a build step seems like the best way to make things easier for contributors without making them harder for the macros.

As you say, actually building the things seems trivial. I'm more worried about where the build code is hosted and how we secure it. Even just where we are now, we're automatically building (parts of) hundreds of MDN pages from content that lives outside developer.mozilla.org. To the extent that we can trust access to this repo, that's OK, but are we further extending our trust by having a build step?

from browser-compat-data.

JeremiePat avatar JeremiePat commented on April 28, 2024

My opinion here is that the build mechanism should be part of that repo as it will makes things easier to maintain in the short term. If we agree on #22, I would suggest the following organization:

Folder structure:

.src
.tools
.tools/hooks
.tools/scripts
data

.src will contain all the JSON files with our data that needs to be maintained

data will contain the built (aggregated, minified) JSON files ready to be used

.tools/scripts will contain all the necessary script (Node.js scripts) to make the build, run tests, etc.

.tools/hooks will contain git hooks necessary to enhance testing and build to make sure the whole data set remain coherent (at that point, as we are using Travis to automate testing, it is not a hard requirement, just some nice helpers).

On top of that, we can use NPM script to run everything is needed (at minimum I suggest npm test and npm run build)

Such organization will make things easier if it appears that maintaining the tool chain and the data in the same repo is not sustainable (but I doubt so at that stage)

from browser-compat-data.

Elchi3 avatar Elchi3 commented on April 28, 2024

WebExtension JSON files were the only ones with this problem. I'm calling this fixed.

from browser-compat-data.

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.