Moved folder structure

[seethroughdev]

This is a v2.0 milestone to create a more consistent directory structure for the project as described in: #262

There were no actual code changes, however, paths were updated to work with the new separate folders. In the demo files I removed a path to metricsgraphics-layout.css that has a 404 in production.

I also created specs, gulp, and scss folders. Those will be updated in future tickets.

I made a couple of small additions to the package.json to allow for future npm use. As well as an index.js file. That will be valuable if we can migrate the library to be commonjs/amd compatible.

Let me know if you want me to set the PR to a v2 branch or anything...

Hope it helps.

[seethroughdev]

One thing I noticed is that the make.py has bootstrap scripts in the array and the gulpfile doesn't. So when i tested the current gulpfile, the distributed files are different. Not sure if this was intentional or not, but wanted to make sure to point it out.

[almossawi]

Wonderful, thank you. v2.0 is planned for release next Friday, Dec 18th.

[seethroughdev]

No problem, if you decide to merge, I can rebase it again first.

I'd like to improve on the gulp build from: #222 -- it will make the other tickets we discussed easier to implement.

But i'll wait to see the status of this so I know where to setup the paths...

[almossawi]

@seethroughtrees Yes, if you wouldn't mind rebasing, please, in preparation for merging it.

[seethroughdev]

Hi @almossawi , okay, I fixed the merge conflicts, and re-updated all the paths for the new testem files. I was able to successfully run the new test suite with the updated directory structure to verify.

One thing I do notice is that the src/js files when compiled are still different than the /dist/ versions. I'm wondering if that's just how you guys are developing between versions? or if there's another issue here.

But regardless, the files should be good to go now. If you are going to go with this structure, I'd request testing and merging in sooner than later, as the conflicts are hard to manage with the new paths. And there are lots of improvements to be made after :)

Let me know. Thanks...

[almossawi]

Hi Adam, Would you mind checking the paths in dev.htm and examples.htm, please. Also, seems like lib wasn't committed. Otherwise, I'll be back in a few hours and can take a look at it then. Thanks.

[seethroughdev]

I moved lib to /dist/ so it would stay at the top of the structure. Looks like I forgot to update the html for that change. Doing it right now, it will be ready when you get back!

[seethroughdev]

I updated the new PR here: https://github.com/mozilla/metrics-graphics/pull/272/files

One thing worth mentioning: to keep the /dist/ folders out of the examples folder but still able to reference them. An example server needs to point to root so the path is /examples/dev.htm instead of /dev.htm

Let me know if that makes sense and is acceptable. The other option is to duplicate the library files inside of /examples/ which would easily be automated with gulp on compile. So there still wouldn't be any maintenance.

option a: keeps a clear separation, but requires the extra folder in the pathname
option b: duplicates files, but as long as it is automated, it makes the example folder more self-contained

Let me know whatever you prefer. If you want option b, I can easily do it tonight.

[almossawi]

I think it would be valuable to keep /examples self-contained. @hamilton Do you have a preference?

On another note, I wanted to fix the links to images/missing-data.png from /dist/metricsgraphics.css. Any issues with copying said image to /dist or would you suggest linking to its current location under /examples?

[seethroughdev]

I agree with you on the self-contained. As long as the dist/ and examples/ versions are compiled from the same source, I think its no big deal. And only further decouples the two.

I have an updated gulp build to to PR in a bit, so I'll include pushing to both locations. I'll wait for @hamilton to weight in though.

As far as the missing-data.png, I've been thinking about that one as well. I guess if its truly part of the library, we should include it in /dist/, but it does feel slightly out of place to me.

If its really a must-have, I could also inline it with base64... Just a thought..

[almossawi]

I suppose it wouldn't be unreasonable to move the .missing css rule to /examples/css/metricsgraphics-demo.css. That would be in line with some of the other recent changes that we've made. @hamilton Let me know if you disagree.

Thanks for the other PR 👍

[hamilton]

What if we re-implement the data-missing image as an svg? It would be more portable that way.

[hamilton]

Also would be pretty easy to do. It's only a couple of paths & areas.

[almossawi]

@hamilton Sounds good. I'll create a new issue for that then.