tamriel-foundry / apocrypha

Theme files for Tamriel Foundry
2 stars 1 forks source link

General Project Discussion #10

Open jaspervalero opened 11 years ago

jaspervalero commented 11 years ago

Opening up this general discussion for quick updates to each other in between TS3 chats and emails.

Just wanted to say you're beasting on this theme. :)

Also I'm doing some significant work in foundry.js at the moment. Mainly just refactoring some things and minor clean up. All functionality will remain the same as it is currently.

aaclayton commented 11 years ago

Alright, thanks Jasper. Do me a favor, and make sure that all your javascript changes are mirrored in the sub-components of the "raw" folder.

There's a lot of JS associated with TF, and when I concatenate it all into foundry.js it gets difficult to find anything, so I keep the individual scripts in the raw folder so I can edit bits a la carte.

Will you be around TS at all later?

aaclayton commented 11 years ago

Hey @jaspervalero, I just pushed a commit today "Improved comment, topic, and reply form semantics". Within that commit there are three templates I'd like you to take a look at.

We discussed a bit yesterday the merits of different semantic form constructions. I'd like to make sure our content submission forms are consistent and thoughtfully written, as they are the gatekeepers of TF content! If you have some free time, compare the three and let me know if you have any thoughts.

jaspervalero commented 11 years ago

I'll take a look at everything this weekend.

In the mean time, I've been meaning to discuss the development workflow with you on this project. I know you have your process and the way you like to organize things, but there is an easier way to manage things. I've put together a simple diagram to use as a reference as I share my thoughts with you.

Development Work Flow (Figure 1): image

So as you can see in the diagram, the ideal workflow is to have all raw source files in the src/ folder. When completing work, you run the grunt build task from the command line. This executes all of the tasks that make up the build script. This includes: linting (error checking code), minification, concatenation (not in place yet) and anything else we add down the road. It then outputs the result of the build script in the the dist/ folder.

At the moment it appears you're doing minification and concatenation manually, in some places.

For example: library/js/raw --> library/js/foundry.js

There really isn't a need to do this manually. It can be handled by Grunt with a simple command. One reason the current system is less than ideal is as I begin to add files, I have to first create the new file in the raw folder. I then have to add an additional JavaScript include in the footer on both the src and dist versions of the theme folders.

This begins to become a growing headache the more we add to the repo. It is much better to just add the file and let Grunt output it to foundry.js. There are several more reasons why the system diagramed above is more efficient, but for now I'll offer up the one example.

Additionally, I know you said you do your work directly in your Wordpress install file. This is a personal choice, but it will lengthen the duration it takes you to fully grasp Git. This is because you'll be forever working outside the bounds of your repo and just copying and pasting back in. I know this is easier from a testing standpoint within our local TF install. But may I suggest finding a way to automate the push out of the dist theme folder upon save, or we can probably add it as part of the Grunt build script as well.

My best advice is to challenge yourself to step out of your comfort zone. You're a quick learner, so might as well continue to push yourself. :)

aaclayton commented 11 years ago

Hey man, thanks for this feedback. I'll work a bit harder on picking up the framework we want to implement. In the meantime, I'm working on a slight re-imagining of how the Apocrypha theme class is going to work, so I'm passing through a few structural changes to the theme constructor.

jaspervalero commented 11 years ago

Interesting. Look forward to checking out the changes. I'll get the advanced search finished up, this weekend. I'll also take a thorough look at the files you asked me to above and the Wordpress portion in general. I'm also going to hunt down and fix the issues that the JavaScript linting (aka JSHint) is picking up on.

jaspervalero commented 11 years ago

Oh btw, I'd suggest making this repo private.

aaclayton commented 11 years ago

There's definitely a growing list of things that we need to talk about, I hope we'll have time to put our heads together sometime this weekend.

jaspervalero commented 11 years ago

I'll be on about 6:30 or 7pm and will be around the rest of the night from then.

On Saturday, August 17, 2013, Andrew wrote:

There's definitely a growing list of things that we need to talk about, I hope we'll have time to put our heads together sometime this weekend.

— Reply to this email directly or view it on GitHubhttps://github.com/tamriel-foundry/apocrypha/issues/10#issuecomment-22818301 .

aaclayton commented 11 years ago

Aah, bummer. We are going to miss each other today then. I have dinner plans at a friend's place at 6:30. No worries.

jaspervalero commented 11 years ago

Well I'll be around late if you are on after, and I should be around almost all day tomorrow. Enjoy your dinner!

aaclayton commented 11 years ago

Alright man, that works. I'm not positive when I'll be home, but probably around 10pm