It would be really beneficial to have some documentation about best practices of starting to use this module.

After having spent some time with it this morning, I really am not sure I'm seeing the benefits I was expecting.

Mostly, I think it's because I don't know where I should look and how it should be working.

The README.txt is good, but there should be a handbook.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mikeytown2’s picture

A goal of mine is to create a short video explaining what every setting does... Not sure if I will ever get the time to do that though. Most of what is written below can be found in the readme or on the project page. Let me know what questions you have so I can answer them; for example - on this admin page what does this setting do?

The core AdvAgg module only does a couple of things and mainly allows for the sub-modules to work with minimal code needed. Things the core module does:
- Cache the rendered css/js html so pages get generated faster (aggressive cache).
- Generate aggregates in the background so pages get generated faster (if httprl is enabled).
- Combine CSS better than core does by putting media groups together.
- Prevent more than 4095 CSS selectors from being used in a CSS file (prevent IE bug from causing bad things).
- Fix improperly added types (file to external, external to file; only if it was set incorrectly).

Sub modules then take advantage of the AdvAgg hooks to provide additional things.
- CSS/JS minification.
- Bundling to set a target number of files to download on each request (1 css & 1 js is usually not optimal).
- CSS/JS cdn support so jquery and friends can be downloaded from the google cdn.
- CSS/JS validation to make sure your source files for the aggregates are good.
- AdvAgg mod to do some unique things that should speed up the front end and allow for better grouping of CSS & JS.

mgifford’s picture

Issue tags: +Documentation

Videos take a bunch of time. I think it's better to focus first on:

  1. Adding a Getting started section to the README.txt
  2. Adding a child page about this module to this handbook https://drupal.org/node/326504
  3. Improving the inline docs

Let me see if I can get started on some of 1 & 3. If you want me to proceed with #2 I can start something.

mgifford’s picture

Note that https://drupal.org/node/326504 probably needs to be updated to include Advanced CSS/JS Aggregation links as well.

mgifford’s picture

FileSize
3.51 KB

This is just a start, but I wanted to get your feedback on the changes.

I need to improve the formatting.

mikeytown2’s picture

Reviewing this patch made me create #2202645: Merge Development & Disabled Cache Settings

This patch has been committed. Keep giving me feedback/patches in small portions as that makes it easier to review. Leaving this issue open :)

Side note is I'm trying to follow markdown inside the readme; I put it through a markdown parser every now and then to make sure things look good.

mgifford’s picture

FileSize
3.88 KB

Thanks @mikeytown2 - glad to be able to help.

In the README.txt there is a menu for "Operations" but not "Perform An Operation". I suspect that the UI for /admin/config/development/performance/advagg/operations should be just "Operations"

Configurations are expected on a module as most have a config page. However, what is an Operations page? What do you mean by Operations? It probably should have an explanation about how these items are grouped.

It should be done at the top of the page as well as in the README file.

The language & case of a button should be consistent with the text describing it. Changed "Delete Unused Aggregates from Database" by capitalizing & removing "the". I don't care if the "the" is there, but I do care that it's consistent.

What are the 3 sections of the Operations page about? Why are they grouped this way? The README.txt should have similar spacing. Not sure how you want to do that.

I've read through all of the documentation on this page and I still don't know when I'd click on those buttons. They all look like things that should happen automatically. There must be a garbage collection feature for this module that generally handles this, right?

I think it might be useful to let folks know that the Information & Operations pages probably aren't needed for most users (unless they are).

mgifford’s picture

Status: Active » Needs review
mikeytown2’s picture

Status: Needs review » Active
FileSize
22.24 KB

Thanks again :)
This patch has been committed.

Edit: This as well http://drupalcode.org/project/advagg.git/commit/0191a536bd639ef53ec6748c...

mgifford’s picture

Glad to help..

mikeytown2’s picture

Have anything else? It really helps when I have someone else tell me what is confusing :)
If not go ahead and change this issue to fixed.

mgifford’s picture

I should get through the sub-modules before closing it.

So I'm right then about my assumptions with the Operations & Information pages? Really it's there for debugging, developing or when you just need to say WTF?

Most users shouldn't need to worry about those two pages I assume.

mikeytown2’s picture

So I'm right then about my assumptions with the Operations & Information pages? Really it's there for debugging, developing or when you just need to say WTF?

Most users shouldn't need to worry about those two pages I assume.

That is correct.

mikeytown2’s picture

I'm going to work on the admin side of the advagg mod module. It could use some cleanup.
#2207075: Clean up advagg_mod admin page

mikeytown2’s picture

Anything else to add? I'll be trying to get a new version out sometime next week and I would like to have any additional contributions from you included :)

mgifford’s picture

I think I'm going to have to wait a bit before contributing more.. Got a few other fires on the burner I need to take care of first.

mikeytown2’s picture

Status: Active » Postponed (maintainer needs more info)

Marking this as postponed until I get more feedback :)

mgifford’s picture

Makes sense.

mikeytown2’s picture

Status: Postponed (maintainer needs more info) » Active

More things to add to the Readme
http://drupal.stackexchange.com/questions/107311/eliminate-render-blocki...

Also got me thinking that I should have an experimental JS setting for adding async to all script tags.

mikeytown2’s picture

mikeytown2’s picture

Status: Postponed (maintainer needs more info) » Fixed

Marking this issue as fixed.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.