richard
/
SemanSemantic-UItic-UI
mirror of https://github.com/Semantic-Org/Semantic-UI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

finish writing dev guide 

Former-commit-id: ed505e417d
Former-commit-id: 4f475b2864
pull/258/head
jlukic 11 years ago
parent
9fd780fb7e
commit
b75487d544
2 changed files with 51 additions and 27 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 42
      node/src/documents/project/contributing.html
  2. 36
      node/src/documents/project/development.html

42
node/src/documents/project/contributing.html
View File

@ -8,16 +8,16 @@ type : 'Semantic Project'
<script src="/javascript/intro.js"></script>
<div class="segment">
<div class="container">
<h1 class="ui header">Contributing
</h1>
<h1 class="ui header">Contributing</h1>
<p>It takes a village</p>
</div>
</div>
<div class="main container">
<div class="peek">
<div class="ui vertical pointing secondary menu">
<a class="item">Introduction</a>
<a class="item">Ways to Contribute</a>
<a class="item">Community</a>
<a class="active item">Introduction</a>
<a class="item">Contributing</a>
<a class="item">Specification</a>
</div>
</div>
@ -30,6 +30,8 @@ type : 'Semantic Project'
<h3 class="ui header">Publicity</h3>
<p>One of the easiest ways to support Semantic UI is to get the word out</p>
<script id='fbrob7c'>(function(i){var f,s=document.getElementById(i);f=document.createElement('iframe');f.src='//api.flattr.com/button/view/?uid=jlukic&button=compact&url=https%3A%2F%2Fgithub.com%2Fjlukic%2FSemantic-UI';f.title='Flattr';f.height=31;f.width=110;f.style.marginRight=10;f.style.borderWidth=0;s.parentNode.insertBefore(f,s);})('fbrob7c');</script>
<iframe src="http://ghbtns.com/github-btn.html?user=jlukic&repo=semantic=ui&type=watch&count=true&size=large"
@ -45,13 +47,7 @@ type : 'Semantic Project'
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<h2 class="ui dividing header">Ways to Contribute</h2>
<h3 class="ui header">Style Guide</h3>
<p>Contributors should read over the coding guidelines for the project. Most importantly, the guide for language, as it is one of the most important parts about Semantic UI.</p>
<a class="ui secondary button" href="/guide/styleguide.html">Language</a>
<a class="ui button" href="/guide/cssguide.html">CSS</a>
<a class="ui button" href="/guide/javascript.html">Javascript</a>
<h2 class="ui dividing header">Making Semantic Better</h2>
<h3 class="ui dividing header">Bugs & Issues</h3>
@ -59,13 +55,25 @@ type : 'Semantic Project'
<p>When submiting a bug report, please include a set of steps to reproduce the issue and any related information, browser, OS etc. If we can't see the issue then it will make solving things much more difficult.</p>
<h3 class="ui header">Style Guide</h3>
<p>Contributors should read over the coding guidelines for the project. Most importantly, the guide for language, as it is one of the most important parts about Semantic UI.</p>
<a class="ui secondary button" href="/guide/styleguide.html">Language</a>
<a class="ui button" href="/guide/cssguide.html">CSS</a>
<a class="ui button" href="/guide/javascript.html">Javascript</a>
<h3 class="ui dividing header">Pull Requests</h3>
<p>Anyone can jump on the issues board and grab off bugs to fix. This is probably the best way to become a contributor to Semantic. Be sure to adhere to the style guides when submitting code.</p>
<h3 class="ui dividing header">Expanding Library UI</h3>
<ul class="ui list">
<li><a href="https://github.com/jlukic/Semantic-UI/compare/">Create a Pull Request</a></li>
<li><a href="https://github.com/jlukic/Semantic-UI/issues?state=open">View Open Issues</a></li>
</ul>
<h3 class="ui dividing header">Expanding UI</h3>
<p>Semantic is looking for people to help contribute new UI components, and suggest extensions for our core library</p>
<p>Semantic is looking for people to help contribute new core UI components, and suggest extensions for the library.</p>
<p>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.</p>
@ -76,7 +84,7 @@ type : 'Semantic Project'
</div>
<h2 class="ui diving header">Community Development</h2>
<h2 class="ui diving header">Specification Development</h2>
<p>We're looking currently for ideas on the best way to expand Semantic to include both core library and third party components. This requires creating a component specification which can be used by anyone to create ui components, and a package management system (website or command line) for authors to distribute them.</p>
@ -89,8 +97,8 @@ type : 'Semantic Project'
</div>
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/element.html">
Next: Building Semantic
<a class="ui large right labeled teal icon button" href="/project/development.html">
Next: Developing Semantic
<i class="right arrow icon"></i>
</a>
</div>

node/src/documents/project/build.html → node/src/documents/project/development.html
View File

@ -2,26 +2,26 @@
layout : 'default'
css : 'build'
title : 'Building Semantic'
title : 'Development'
type : 'Semantic Project'
---
<script src="/javascript/intro.js"></script>
<div class="segment">
<div class="container">
<h1 class="ui header">Contributing
<div class="ui label">Draft</div>
</h1>
<h1 class="ui dividing header">Development</h1>
<p>A guide to developing locally</p>
</div>
</div>
<div class="main container">
<div class="peek">
<div class="ui vertical pointing secondary menu">
<a class="item">Running Locally</a>
<a class="item">Building packages</a>
<a class="active item">Running Locally</a>
<a class="item">Fixing Bugs</a>
<a class="item">The Future</a>
</div>
</div>
<h2 class="ui dividing header">Running Semantic Locally</h2>
<h2 class="ui dividing header">Running Locally</h2>
<p>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.</p>
@ -52,7 +52,7 @@ type : 'Semantic Project'
<h3 class="ui header">4) Start Your Server</h3>
<p>It's important to note that all development code exists inside of <code>/node</code> inside the project. So all commands should be run relative to that directory.</p>
<p>It's important to note that all server code exists inside of <code>/node</code> in the project. So all commands should be run relative to that directory.</p>
<div class="code" data-title="Starting server locally" data-type="terminal">
cd node
@ -61,10 +61,11 @@ type : 'Semantic Project'
<p>Docpad should now run an instance of semantic-ui.com locally you can access at <code>http://localhost:9778</code></p>
<h2 class="ui dividing header">Fixing Bugs</h2>
<h3 class="ui header">Fixing An Element</h3>
<h3 class="ui header">Watch Script</h3>
<p>If you are working on fixing a UI element that is part of Semantic, your best bet is to work actively on the file in <code>/src/{type}/{elementname}/</code> 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.</p>
<p>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 <code>/src/{type}/{elementname}/</code> 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.</p>
<p>To see exactly what this is doing you can check out our <a href="https://github.com/jlukic/Semantic-UI/blob/master/node/Gruntfile.js">commented gruntfile</a></p>
@ -81,6 +82,21 @@ type : 'Semantic Project'
grunt build
</div>
<h2 class="ui dividing header">The Future</h2>
<h3 class="ui header">UI Dev Kits</h3>
<p>We are working to create development kits for writing and distributing third party UI definitions. These, are planned to land after our 1.0 release and allow other developers to contribute ui components or reskins of existing components.</p>
<p>For more information on the development of the UI specification for third party components, please visit our community discussion boards on Trello</p>
<h4 class="ui header">Development Boards</h4>
<div class="ui buttons">
<a class="ui button" href="https://trello.com/b/FZvMsVIM/semantic-ui-community">Public</a>
<a class="ui button" href="https://trello.com/b/dtmaAEmg/semantic-ui-components-contributors">Contributor</a>
</div>
<h3 class="ui header"></h3>
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/introduction.html">
Next: Library Introduction
Write Preview
Loading…
Cancel
Save