Skip to content

Commit

Permalink
Documentation: Added getting started and using GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Jackson authored and Paul Jackson committed Jan 7, 2014
1 parent c2ee0ed commit a7b2915
Show file tree
Hide file tree
Showing 9 changed files with 1,179 additions and 13 deletions.
336 changes: 336 additions & 0 deletions docs/gettingstarted/github-en.html
View file

Large diffs are not rendered by default.

339 changes: 339 additions & 0 deletions docs/gettingstarted/github-fr.html
View file

Large diffs are not rendered by default.

Binary file added docs/gettingstarted/images/git-pullrequest.JPG
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gettingstarted/images/git-remotes.JPG
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gettingstarted/images/git_explain.JPG
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
244 changes: 244 additions & 0 deletions docs/gettingstarted/index-en.html
View file
@@ -0,0 +1,244 @@
<!DOCTYPE html>
<!--[if IE 7]><html lang="en" class="no-js ie7"><![endif]-->
<!--[if IE 8]><html lang="en" class="no-js ie8"><![endif]-->
<!--[if gt IE 8]><!-->
<html lang="en" class="no-js">
<!--<![endif]-->
<head>
<meta charset="utf-8" />
<!-- Web Experience Toolkit (WET) / Boîte à outils de l'expérience Web (BOEW)
wet-boew.github.io/wet-boew/License-en.html / wet-boew.github.io/wet-boew/Licence-fr.html -->
<title>Getting started - Documentation - Web Experience Toolkit (WET)</title>

<link rel="shortcut icon" href="../../dist/theme-gcwu-fegc/images/favicon.ico" />
<meta name="description" content="English description / Description en anglais" />
<meta name="dcterms.creator" content="English name of the content author / Nom en anglais de l'auteur du contenu" />
<meta name="dcterms.title" content="English title / Titre en anglais" />
<meta name="dcterms.issued" title="W3CDTF" content="Date published (YYYY-MM-DD) / Date de publication (AAAA-MM-JJ)" />
<meta name="dcterms.modified" title="W3CDTF" content="Date modified (YYYY-MM-DD) / Date de modification (AAAA-MM-JJ)" />
<meta name="dcterms.subject" title="scheme" content="English subject terms / Termes de sujet en anglais" />
<meta name="dcterms.language" title="ISO639-2" content="eng" />
<meta name="viewport" content="width=device-width, initial-scale=1" />

<script src="../../dist/js/jquery.min.js"></script>
<!--[if lte IE 8]>
<script src="../../dist/js/polyfills/html5shiv-min.js"></script>
<link rel="stylesheet" href="../../dist/grids/css/util-ie-min.css" />
<link rel="stylesheet" href="../../dist/js/css/pe-ap-ie-min.css" />
<link rel="stylesheet" href="../../dist/theme-gcwu-fegc/css/theme-ie-min.css" />
<![endif]-->
<!--[if gt IE 8]><!-->
<link rel="stylesheet" href="../../dist/grids/css/util-min.css" />
<link rel="stylesheet" href="../../dist/js/css/pe-ap-min.css" />
<link rel="stylesheet" href="../../dist/theme-gcwu-fegc/css/theme-min.css" />
<!--<![endif]-->
<noscript><link rel="stylesheet" href="../../dist/theme-gcwu-fegc/css/theme-ns-min.css" /></noscript>

<!-- CustomScriptsCSSStart -->
<!-- CustomScriptsCSSEnd -->
</head>

<body><div id="wb-body">
<div id="wb-skip">
<ul id="wb-tphp">
<li id="wb-skip1"><a href="#wb-cont">Skip to main content</a></li>
<li id="wb-skip2"><a href="#wb-nav">Skip to footer</a></li>
</ul>
</div>

<div id="wb-head"><div id="wb-head-in"><header>
<!-- HeaderStart -->
<nav role="navigation"><div id="gcwu-gcnb"><h2>Government of Canada navigation bar</h2><div id="gcwu-gcnb-in"><div id="gcwu-gcnb-fip">
<div id="gcwu-sig"><div id="gcwu-sig-in"><div id="gcwu-sig-eng" title="Government of Canada"><img src="../../dist/theme-gcwu-fegc/images/sig-en.gif" width="214" height="20" alt="Government of Canada" /></div></div></div>
<ul>
<li id="gcwu-gcnb1"><a rel="external" href="http://www.canada.gc.ca/menu-eng.html">Canada.gc.ca</a></li>
<li id="gcwu-gcnb2"><a rel="external" href="http://www.servicecanada.gc.ca/eng/home.shtml">Services</a></li>
<li id="gcwu-gcnb3"><a rel="external" href="http://www.canada.gc.ca/aboutgov-ausujetgouv/depts/menu-eng.html">Departments</a></li>
<li id="gcwu-gcnb-lang"><a href="index-fr.html" lang="fr">Français</a></li>
</ul>
</div></div></div></nav>

<div id="gcwu-bnr" role="banner"><div id="gcwu-bnr-in">
<div id="gcwu-wmms"><div id="gcwu-wmms-in"><div id="gcwu-wmms-fip" title="Symbol of the Government of Canada"><img src="../../dist/theme-gcwu-fegc/images/wmms.gif" width="126" height="30" alt="Symbol of the Government of Canada" /></div></div></div>
<div id="gcwu-title"><p id="gcwu-title-in"><a href="../../index-en.html">Web Experience Toolkit&#160;(WET)</a></p></div>

<section role="search"><div id="gcwu-srchbx"><h2>Search</h2>
<form action="#" method="post"><div id="gcwu-srchbx-in">
<label for="gcwu-srch">Search website</label><input id="gcwu-srch" name="gcwu-srch" type="search" value="" size="27" maxlength="150" />
<input id="gcwu-srch-submit" name="gcwu-srch-submit" type="submit" value="Search" data-icon="search" />
</div></form>
</div></section>
</div></div>

<nav role="navigation">
<div id="gcwu-psnb"><h2><span>Site </span>menu</h2><div id="gcwu-psnb-in"><div class="wet-boew-menubar mb-mega"><div>
<ul class="mb-menu" data-ajax-replace="../../demos/includes/menu-en.txt">
<li><div><a href="http://wet-boew.github.io/wet-boew/index-en.html">WET project</a></div></li>
<li><div><a href="section2/index-en.html">Section 2</a></div></li>
<li><div><a href="#">Section 3</a></div></li>
<li><div><a href="#">Section 4</a></div></li>
<li><div><a href="#">Section 5</a></div></li>
<li><div><a href="#">Section 6</a></div></li>
<li><div><a href="#">Section 7</a></div></li>
</ul>
</div></div></div></div>

<div id="gcwu-bc"><h2>Breadcrumb trail</h2><div id="gcwu-bc-in">
<ol>
<li><a href="../../index-en.html">Home</a></li>
<li><a href="../index-en.html">Documentation</a></li>
<li>Getting started</li>
</ol>
</div></div>
</nav>
<!-- HeaderEnd -->
</header></div></div>

<div id="wb-core"><div id="wb-core-in" class="equalize">
<div id="wb-main" role="main"><div id="wb-main-in">
<!-- MainContentStart -->
<h1 id="wb-cont">Getting started</h1>

<section>
<h2>Overview</h2>
<p>The Web Experience Toolkit (WET) includes reusable components for building and maintaining innovative websites that are accessible, usable, and interoperable. Unlike previous versions, WET allows developers to package and optimize their JavaScript, CSS and plugins. This final build folder can be used by publishers to style and provide functionality to their websites.</p>
<p>The following documentation provides new users and contributors with the resources needed to create a website using WET.</p>
</section>

<section>
<h2>Why WET?</h2>
<p>WET is a toolkit which includes reusable components that can be used by web professionals to build websites. WET complies with the [[Web Standards|http://www.tbs-sct.gc.ca/ws-nw/index-eng.asp]] released by the Government of Canada, and helps sites that employ it achieve compliance. It is also an open source project which is free to use and contribute to through GitHub.</p>
<section>
<h3>Benefits</h3>
<ul>
<li>Focus is on mobile development.</li>
<li>Simpler calling system for plugins.</li>
<li>CSS standardization and optimization.</li>
<li>More CMS friendly.</li>
<li>Provides reusable components.</li>
<li>Respects accessibility (WCAG 2.0 AA and WAI-ARIA), usability, and interoperability principles.</li>
<li>Reduces costs by providing re-usable Web tools and solutions.</li>
<li>Open source software that is free to use.</li>
<li>Uses advanced technologies, such as:
<ul>
<li>HTML5, CSS3, jQuery (JavaScript framework);</li>
<li>Ever-growing list of open source plugins and widgets; and</li>
<li>Supports a wide range of layouts and designs.</li>
</ul>
</li>
</ul>
</section>
</section>

<section>
<h2>Main Components</h2>
<ul>
<li><strong>WET Core Framework:</strong> The WET Core Framework includes functionality used in all WET pages. This includes jQuery plugins and CSS, JavaScript for processing mobile views and external libraries.</li>
<li><strong>Base CSS:</strong> Every WET site uses a series of base CSS classes which are not theme dependent.</li>
<li><strong>CSS Grid System:</strong> The grid system is CSS to style the content of the page using grids. It also includes additional CSS styles for the content area of Government of Canada websites.</li>
<li><strong>Theming:</strong> Themes are composed of theme-specific style sheets, images and jQuery.</li>
<li><strong>Mobile support:</strong> WET allows pages to display differently on mobile devices.</li>
<li><strong>i18n localization system:</strong> Language integration file which translates key words based on the language specified in html lang attribute.</li>
</ul>
</section>

<section>
<h2>Directory Structure</h2>
<p>The following is an overview of the different directories contained in the WET project and their purpose.</p>
<ul>
<li><strong>build:</strong> Contains the build scripts and build dependencies for WET.
<li><strong>dist:</strong> This directory contains everything required to implement WET on a website, including a variety of different components such as plugins, CSS and themes.
<ul>
<li><strong>grids:</strong> Includes CSS and images included in the grid system.
<li><strong>js:</strong> Includes files for JQuery functionality, plugins and the CSS used to display styles.
<li><strong>lib:</strong> Contains libraries used as part of the build process. **Not required for implementation.**
<li><strong>theme-gcwu-fegc:</strong> This is the GC Web Usability theme, designed for all external facing Government of Canada websites.
<li><strong>theme-gcwu-intranet:</strong> This is the GC Web Usability Intranet theme, designed for all internal facing Government of Canada websites.
</ul>
</li>
<li><strong>demos:</strong> This folder contains the working examples for all WET features, components and plug-ins.
<li><strong>docs:</strong> This folder contains the documentation for WET [http://wet-boew.github.io/wet-boew/demos/index-en.html WET documentation] (Working examples).
<li><strong>src:</strong> This folder includes the initial files and source code for WET and is used solely for WET development. The dist folder is built from code contained in this folder.
<li><strong>test:</strong> This folder is used for testing purposes by the developers of WET.
</ul>
</section>

<section>
<h2>What Next?</h2>
<p>Now that you know a little bit about the WET, see the following pages for information on how to use and contribute to WET:</p>
<ul>
<li><strong><a href="github-en.html">Using Github for WET</a>:</strong> This page contains information on how to use GitHub to use or contribute to WET.</li>
<li><strong><a href="implementing-en.html">Implementing WET</a>:</strong> This page contains the information necessary to implement WET on your website.</li>
<li><strong><a href="developing-en.html">Developing for WET</a>:</strong> This page explains how WET works and has all the necessary information to contribute your own plugin or feature to WET.</li>
</ul>
</section>

<dl id="gcwu-date-mod" role="contentinfo">
<dt>Date modified:</dt><dd><span><time>2013-09-01</time></span></dd>
</dl>
<div class="clear"></div>
<!-- MainContentEnd -->
</div></div>
</div></div>

<div id="wb-foot"><div id="wb-foot-in"><footer><h2 id="wb-nav">Footer</h2>
<!-- FooterStart -->
<nav role="navigation"><div id="gcwu-sft"><h3>Site footer</h3><div id="gcwu-sft-in">
<div id="gcwu-tctr">
<ul>
<li class="gcwu-tc"><a href="#" rel="license">Terms and conditions</a></li>
<li class="gcwu-tr"><a href="#">Transparency</a></li>
</ul>
</div>
<div class="clear"></div>
<section><div class="span-2"><h4 class="gcwu-col-head"><a href="#">About us</a></h4>
<ul>
<li><a href="#">Our Mandate</a></li>
<li><a href="#">Our Minister</a></li>
</ul>
</div></section>
<section><div class="span-2"><h4 class="gcwu-col-head"><a href="#">News</a></h4>
<ul>
<li><a href="#">News releases</a></li>
<li><a href="#">Media advisories</a></li>
<li><a href="#">Multimedia</a></li>
</ul>
</div></section>
<section><div class="span-2"><h4 class="gcwu-col-head"><a href="#">Contact us</a></h4>
<address>
<ul>
<li><a href="#">Phone numbers</a></li>
<li><a href="#">Office locations</a></li>
</ul>
</address>
</div></section>
<section><div class="span-2"><h4 class="gcwu-col-head"><a href="#">Stay connected</a></h4>
<ul>
<li><a rel="external" href="#">YouTube</a></li>
<li><a rel="external" href="#">Twitter</a></li>
<li><a href="#">Feeds</a></li>
</ul>
</div></section>
</div></div></nav>

<nav role="navigation"><div id="gcwu-gcft"><h3>Government of Canada footer</h3><div id="gcwu-gcft-in"><div id="gcwu-gcft-fip">
<ul>
<li><a rel="external" href="http://healthycanadians.gc.ca/index-eng.php"><span>Health</span><br />healthycanadians.gc.ca</a></li>
<li><a rel="external" href="http://www.voyage.gc.ca/index-eng.asp"><span>Travel</span><br />travel.gc.ca</a></li>
<li><a rel="external" href="http://www.servicecanada.gc.ca/eng/home.shtml"><span>Service Canada</span><br />servicecanada.gc.ca</a></li>
<li><a rel="external" href="http://www.jobbank.gc.ca/intro-eng.aspx"><span>Jobs</span><br />jobbank.gc.ca</a></li>
<li><a rel="external" href="http://actionplan.gc.ca/en"><span>Economy</span><br />actionplan.gc.ca</a></li>
<li id="gcwu-gcft-ca"><div><a rel="external" href="http://www.canada.gc.ca/menu-eng.html">Canada.gc.ca</a></div></li>
</ul>
</div></div></div></nav>
<!-- FooterEnd -->
</footer>
</div></div></div>

<!-- ScriptsStart -->
<script src="../../dist/theme-gcwu-fegc/js/theme-min.js"></script>
<script src="../../dist/js/settings.js"></script>
<script src="../../dist/js/pe-ap-min.js"></script>
<!-- ScriptsEnd -->
</body>
</html>

0 comments on commit a7b2915

Please sign in to comment.