From b7f88bbf55d2db83af03e59988d40d3cab15839e Mon Sep 17 00:00:00 2001 From: jlukic Date: Thu, 12 Dec 2013 13:07:36 -0500 Subject: [PATCH] Fixes github paths to no longer use jlukic --- server/documents/index.html.eco | 4 +-- .../documents/project/contributing.html.eco | 30 ++++++++--------- server/documents/project/development.html.eco | 33 ++++++++++++------- server/layouts/default.html.eco | 4 +-- 4 files changed, 39 insertions(+), 32 deletions(-) diff --git a/server/documents/index.html.eco b/server/documents/index.html.eco index 3dcdb3b30..48f2879ab 100755 --- a/server/documents/index.html.eco +++ b/server/documents/index.html.eco @@ -15,7 +15,7 @@ type : 'Semantic'
-

Semantic UI 0.10.1

+

Semantic UI 0.10.1

UI is the vocabulary of the web.

Semantic empowers designers and developers by creating a language for sharing UI.

View UI @@ -264,7 +264,7 @@ type : 'Semantic' @@ -63,7 +63,7 @@ type : 'Semantic Project'

If you have suggestions for components missing from Semantic which you'd like to see in future versions please add them to our public UI Component board. The current list of upcoming components, and their current development status can be seen on the contributor UI board.

- Add an idea + Add an idea

Code

@@ -76,7 +76,7 @@ type : 'Semantic Project'
Help code this
- Share Ideas + Share Ideas
@@ -88,7 +88,7 @@ type : 'Semantic Project'
Help code this
- Share Ideas + Share Ideas
@@ -101,13 +101,13 @@ type : 'Semantic Project'
Help code this
- Share Ideas + Share Ideas

Test Coverage

-

Semantic uses Jasmine with Karma Test Runner and Travis CI to write unit tests for our UI modules.

+

Semantic uses Jasmine with Karma Test Runner and Travis CI to write unit tests for our UI modules.

We need help to increase our code coverage by writing Jasmine tests for modules and to write feature specs which can be used to write tests.

@@ -115,7 +115,7 @@ type : 'Semantic Project'
Help code this
- Share Ideas + Share Ideas
diff --git a/server/documents/project/development.html.eco b/server/documents/project/development.html.eco index 2a9a249c5..118ca114f 100755 --- a/server/documents/project/development.html.eco +++ b/server/documents/project/development.html.eco @@ -2,8 +2,8 @@ layout : 'default' css : 'guide' -title : 'Set-up' -description : 'A guide to developing locally' +title : 'Local Docs' +description : 'A guide to generating docs locally' type : 'Semantic Project' --- @@ -12,12 +12,12 @@ type : 'Semantic Project'
-

Installing Dependencies

+

Step by Step

It may be useful to run the development docs locally when working on a forked version of semantic, as the docs themselves help in testing out changes to ui components.

@@ -33,7 +33,7 @@ type : 'Semantic Project'

2. Fork Semantic

-

3. Install Dependencies

@@ -52,13 +52,22 @@ type : 'Semantic Project'

Docpad should now run an instance of semantic-ui.com locally you can access at http://localhost:9778

-

Fixing Bugs

+

5. (Optional) Install Karma

-

Watch Script

+

+ Unit tests are written in Jasmine, but are run using a test runner called Karma. To install karma you need to grab the npm package. +

+
+ npm install -g karma +
+ +

Using Grunt

+ +

Watch Changes in Source

If you are working on fixing a UI component that is part of Semantic, your best bet is to work actively on the file in /src/{type}/{elementname}/ while running a watch script from grunt. This will rebuild the docs after you make changes, so you can see if you have corrected the issue you are fixing.

-

To see exactly what this is doing you can check out our commented gruntfile

+

To see exactly what this is doing you can check out our commented gruntfile

grunt @@ -66,7 +75,7 @@ type : 'Semantic Project'

The watch task is the default grunt task for Semantic, so you can start it quite simply.

-

Running Tests

+

Run Unit Tests

Tests will automatically run with grunt watch if you have started karma

@@ -78,12 +87,12 @@ type : 'Semantic Project'
npm test // or - grunt build + grunt test // or karma run
-

Packaging Elements

+

Build Semantic Packages Locally

For convenience there is also a separate grunt command for building minified, packaged, and compressed versions of the library.

diff --git a/server/layouts/default.html.eco b/server/layouts/default.html.eco index df6bba50b..1314bd751 100755 --- a/server/layouts/default.html.eco +++ b/server/layouts/default.html.eco @@ -249,12 +249,10 @@
<% end %>