Skip to content

Commit

Permalink
Merge branch 'release/5.0.0-beta.2'
Browse files Browse the repository at this point in the history
  • Loading branch information
w00fz committed Apr 3, 2015
2 parents 92265dc + ed1df0c commit b1a4b70
Show file tree
Hide file tree
Showing 157 changed files with 10,460 additions and 8,583 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ themes/*/magento/skin/default/common

# Compiled
**/.sass-cache
**/*.map
node_modules/*
platforms/wordpress/gantryadmin/cache
platforms/common/node_modules
Expand Down
92 changes: 75 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,88 @@ Gantry Framework

[![Join the chat at https://gitter.im/gantry/gantry5](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gantry/gantry5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Documentation for all the supported platforms can be found from [themes](themes/README.md) folder.
Ready to get started with Gantry 5? That's great! We are here to help.

Best place to get started is to take a look into Gantry Prime which is our primary theme development and testing environment.
On this page, you will get some quick tips to help you hit the ground running with Gantry 5. You can find more detailed documentation for each of these tips by clicking the **Learn More** button at the bottom of each section.

PS. You should run 'composer install' inside 'src/' folder before installing Gantry 5 to your sites.
We hope you enjoy Gantry 5 every bit as much as we have enjoyed making it.

## Browser Requirements

After you have done that, just go into your Joomla / WordPress / phpBB / Magento / Grav installation and run ```{PATH_TO_REPO}/bin/install.sh``` in there.
The back-end administration requirements of Gantry in order of preference are as follows:

## Joomla
* Google Chrome 41+
* Firefox 36+
* Safari 8+
* Opera 28+
* Internet Explorer 10+ (9 supported at limited capacity)

Extensions Manager / Discover / Discover and install all Gantry 5 related extensions. Also remember to enable System - Gantry Administration plugin.
## Installing Gantry 5 and the Hydrogen Theme

## WordPress
Gantry 5 is a framework by which Gantry-powered themes are made. In order for a Gantry theme to work, you will need to install both the **framework** and the **theme**. Doing this is not difficult at all.

In WordPress you should also install Timber plugin before using the theme.
The first thing you need to do is download the latest build of Gantry 5 and Hydrogen. You can do so by clicking the links below, or via [GitHub](http://github.com/gantry/gantry5/).

Directory structure
===================
* [Download Gantry 5](https://github.com/gantry/gantry5/releases/download/5.0.0-beta.2/joomla-pkg_gantry5_v5.0.0-beta.2.zip)
* [Download Hydrogen Theme](https://github.com/gantry/gantry5/releases/download/5.0.0-beta.2/joomla-tpl_g5_hydrogen_v5.0.0-beta.2.zip)

- assets System wide media assets (Font Awesome, Whoops etc).
- bin Scripts to install and build Gantry.
- design Design images for Gantry.
- engines Supported engines (Nucleus, Bootstrap etc).
- platforms Gantry administration, and platform specific plugins etc.
- src Gantry framework and platform specific overrides.
- themes Base themes for Gantry.
>>> During the initial beta, the **Framework** and **Template** are being distributed in different installable packages. A bundled package is planned, but will likely be available after the initial beta launch.
Once you have the latest packages, installation is simple. We have provided a step-by-step guide in the **Installation** portion of this documentation.

[**Learn More**](http://docs.gantry.org/gantry5/basics/installation)

## Accessing the Gantry Administrator

### Joomla
When you have installed and activated both the Gantry framework and Hydrogen, you can access the Gantry 5 administrator in several different ways. The easiest being simply navigating to **Components > Gantry 5 Templates** from the back end of Joomla.

Here, you will see a list of any installed Gantry-powered themes. You can **Preview** the theme from here or select **Configure** to go directly to the **Gantry Administrator** where you can get started modifying your Gantry-powered site.

## Navigating the Gantry 5 Administrator

The Gantry Administrator has multiple administrative tools you can flip through to configure how your Gantry-powered theme looks and functions. Here is a quick breakdown of each of these tools, and what you can do with them.

You will notice the following menu items in the Gantry 5 Administrator:

1. **Menu Editor**: This administrative panel gives you the ability to enhance the platform's menu by altering styling, rearranging links, and creating menu items that sit outside of the CMS's integrated Menu Manager.

2. **About**: This page gives you quick, at-a-glance information about the currently-accessed theme. This is a one-stop shop for information about the theme including: name, version number, creator, support links, features, and more.

3. **Platform Settings**: This button takes you to the CMS' settings page for Gantry 5. In Joomla, this is the **Permissions** configuration page.

4. **Clear Cache**: This button clears the cache files related to Gantry. This includes all of the temporary files outside of CSS and configuration information.

5. **Configuration Dropdown**: This dropdown makes it easy to quickly switch between Configurations without having to leave the Gantry Administrator.

6. **Styles**: This administrative panel gives you access to style related configuration settings. This includes things like theme colors, fonts, style presets, and more.

7. **Settings**: This administrative panel offers you the ability to configure the functional settings of the theme. This includes setting defaults for Particles, as well as enabling/disabling individual Particles.

8. **Layout**: This administrative panel is where you would configure the layout for your theme. Creating an placing module positions, Particles, spacers, and non-rendered scripts such as Google Analytics code is all done in this panel.

[**Learn More**](http://docs.gantry.org/gantry5/configure/gantry-admin)

## What are Configurations, Particles, Atoms, etc.?

Because Gantry 5 is so different from any version of Gantry before it, we came up with some terms to help make sense of the relationships Gantry's new features have with one-another. Here is a quick breakdown of commonly used terms related to Gantry 5.

| Term | Definition |
| :----- | :----- |
| Configuration | A configurable style used in one or more areas of your site. It serves as the container on which a page's style, settings, and layout are set. |
| Particle | A typically small block of data used on the front end. It acts a lot like a widget/module, but can be easily configured in the Gantry 5 Administrator. |
| Atom | A type of Particle that contains non-rendered data, such as custom scripting (JS, CSS, etc.) or analytics scripts for traffic tracking. |

[**Learn More**](http://docs.gantry.org/gantry5/basics/terminology)

## Where to Get Help

A chat room has been set up using [Gitter](https://gitter.im/gantry/gantry5) where you can go to talk about the project with developers, contributors, and other members of the community. This is the best place to go to get quick tips and discuss features with others.

[Documentation](http://docs.gantry.org) is also available, and being continually added to as development progresses. Is something missing? You can contribute to the documentation through GitHub.

## How to Contribute

Contributing to the Gantry 5 framework, or to its associated documentation is easy. Development for both of these projects is being conducted via [Github](http://github.com), where you can submit **Issues** to report any bugs or suggest improvements, as well as submit your own **Pull Requests** to submit your own fixes and additions.

We recommend chatting with the team via [Gitter](https://gitter.im/gantry/gantry5) prior to submitting the pull request to avoid doubling up on a fix that is already pending or likely to be overwritten by an upcoming change.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.0.0-beta.1
5.0.0-beta.2
4 changes: 2 additions & 2 deletions assets/common/application/menu/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var adjustOnViewportChange = function() {
topLevel = $('.g-toplevel'),
pageSurround = $('#g-page-surround'),
mainNav = pageSurround.search('.g-main-nav'),
mobileNav = pageSurround.nextSibling('.g-mobile-nav');
mobileNav = pageSurround.nextSiblings('.g-mobile-nav');

if (window.innerWidth < MBP) {
resetSelectedActive();
Expand Down Expand Up @@ -93,7 +93,7 @@ r(function() {
if (dropdown) { dropdown.removeClass('g-active').addClass('g-inactive'); }
if (toplevel) { toplevel.removeClass('g-slide-out'); }
}
});
});

// Go Back Link for Level 2+
body.delegate('click', '.g-menu-item .g-go-back', function(e, el) {
Expand Down
2 changes: 1 addition & 1 deletion assets/common/application/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"dependencies": {
"domready": "^1.0.7",
"elements": "*"
"elements": "git+https://git@github.com/w00fz/elements.git"
},
"devDependencies": {
"grunt": "~0.4.5",
Expand Down

0 comments on commit b1a4b70

Please sign in to comment.