nmelone/GoldenCheetah
1
0
Fork 0
mirror of https://github.com/GoldenCheetah/GoldenCheetah.git synced 2026-04-15 05:32:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update website with new issue tracker/WIKI

Browse Source
This commit is contained in:
Gareth Coco
2012-11-12 12:55:38 -05:00
parent a970c86533
commit bf4c3e3564
7 changed files with 24 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/Makefile
View File

@@ -72,6 +72,9 @@ search.html: search.content genpage.pl
users-guide.html: users-guide.content genpage.pl
./genpage.pl "User's Guide" $< > $@
wiki.html: wiki.content genpage.pl
./genpage.pl "Wiki" $< > $@
wishlist.html: wishlist.content genpage.pl
./genpage.pl "Wish List" $< > $@

99
doc/bug-tracker.content
View File

@@ -1,97 +1,4 @@
<p>We have an issue tracker set up at
<a href=http://bugs.goldencheetah.org/projects/show/goldencheetah>
bugs.goldencheetah.org</a>. Below are some guidelines for users and
developers for working with the issue tracker.</p>
<big><font face="arial,helvetica,sanserif">
Report a new bug/feature
</font></big>
<p> If you think that you have found a bug in GoldenCheetah or would like
to request a new feature please report it by filing a new issue at our <a
href=http://bugs.goldencheetah.org/projects/show/goldencheetah>issue
tracker</a>. To report a bug/feature request go to the above link and
follow these steps:
<ol>
<li>Login or register for a new account.</li>
<li>Click the "new issue" link near the top of the page.</li>
<li>Select either "bug" or "feature" from the tracker drop-down menu.</li>
<li>Fill out the form including as much detail as possible.<br>
You can upload crashreports, problem files, or screenshots if they
help document the issue.</li>
<li>Click the create button to save your report.<br>
This will also send a copy of your report to the Golden-Cheetah-Users
mailing list.</li>
</ol>
<p>Thanks for helping to improve GoldenCheetah.</p>
<big><font face="arial,helvetica,sanserif">
Managing issues in the tracker
</font></big>
<p>To make it easier for all of us to track the status please try to
adhere to a few simple guidelines listed below.</p>
<font face="arial,helvetica,sanserif">
<b>Issue Status:</b>
</font>
<p>Depending on your account status (non-member, reporter, developer, or
manager) you may be able to update the status of an existing issue. When
working in the bug tracker please update the status appropriately.
Current status options are:</p>
<ul>
<li>New: Default status.
<li>Assigned: issue has been assigned to someone on the project. If you
are a Developer you can assign an issue to someone, including
yourself. If you are working on a fix, please change the status to
Assigned, and post a message stating your plan of attack etc.
<li>Feedback: This could be used to alert others that you have a
proposed fix that you want feed back on. Please attach patches and
make a note. Also remember to tag the issue in your patches.
<li>Resolved: The issue has been corrected. People that have tested the
patch or that submitted the bug should update to this status when
they feel that it has been fixed. If it turns out that it was not
resolved, most users can change the status back to "feedback". If
you do so, please leave a note.
<li>Tempfix: A workaround for the issue has been posted, but we may still be
working on a more long term solution.
<li>Closed: Those with commit access to Github are the only ones that
can mark an issue as closed. That said, if you are submitting a
patch that fixes and issue, please include the "fixes #<issuenum>"
tag to your commit as this will automatically close the issue when your
patch is accepted and pushed to github.
</ul>
<font face="arial,helvetica,sanserif">
<b>Tagging in messages</b>
</font>
<p>The tracker has a very basic tagging and markup scheme that is described in
detail <a href="http://bugs.goldencheetah.org/help/wiki_syntax.html">here</a>.
Perhaps the most useful feature is the ability to use tags to link issues,
commits, etc. When commenting on an issue please use the following tags
when appropriate to automatically create links when:</p>
<table align="center" width="600">
<tr>
<th>Tag</th>
<th>Effect</th>
</tr>
<tr>
<td>Issue #2</td>
<td>Creates a link to existing Issue #2</td>
</tr>
<tr>
<td>commit:e76247a</td>
<td>Creates a link to commit e76247a</td>
</tr>
<tr>
<td>source:src/MainWindow.cpp</td>
<td>Creates a link to src/Mainwindow.cpp in our git repo</td>
</tr>
</table>
<a href="https://github.com/srhea/GoldenCheetah/issues">GitHub</a>.</p>
<p>Here is a <a href="https://github.com/blog/411-github-issue-tracker">
link to short video</a> about the Issue tracker.</p>

4
doc/download.content
View File

@@ -18,8 +18,8 @@ before downloading.
On Linux and Mac OS X, Golden Cheetah also downloads from the SRM PCV. On Mac
OS X, you'll need to install <a href="http://osx-pl2303.sourceforge.net/">the
open source PL2303 driver</a> to download from an SRM. Please see the
<a href="http://bugs.goldencheetah.org/projects/goldencheetah/wiki/">WIKI</a> article
- <a href="http://bugs.goldencheetah.org/projects/goldencheetah/wiki/PCV_on_Mac_OS_X">
<a href="https://github.com/srhea/GoldenCheetah/wiki/Installing-the-d2xx-drivers-on-mac-os">WIKI</a> article
- <a href="https://github.com/srhea/GoldenCheetah/wiki/Pcv-on-mac-os-x">
PCV on Mac OS X</a> for further information.
</p>

2
doc/genpage.pl
View File

@@ -55,7 +55,7 @@ body {
<p> <b><a href="index.html">Introduction</a></b>
<br> <b><a href="screenshots.html">Screenshots</a>
<br> <b><a href="http://bugs.goldencheetah.org/projects/goldencheetah/wiki">Wiki</a>
<br> <b><a href="wiki.html">Wiki</a>
<br> <b><a href="users-guide.html">User's Guide</a>
<br> <b><a href="developers-guide.html">Developer's Guide</a>
<br> <b><a href="faq.html">FAQ</a>

6
doc/users-guide.content
View File

@@ -1,7 +1,7 @@
<!-- $Id: users-guide.content,v 1.5 2006/05/27 16:32:46 srhea Exp $ -->
<p>
Note that more detailed information is often available on the
<a href = http://bugs.goldencheetah.org/projects/goldencheetah/wiki>
<a href = http://github.com/srhea/GoldenCheetah/wiki>
Golden Cheetah Wiki</a>.
<p>
@@ -25,10 +25,10 @@ Depending on your operating system, you <i>may</i> need to install the
you're using the PowerTap's new USB download cradle.
Note: version 0.1.7 of the FTDI drivers for Mac seems to be buggy. Until they
post a patched version, you can download version 0.1.6
<a href="http://bugs.goldencheetah.org/attachments/download/1/Universal_D2XX0.1.6.dmg"> here</a>
<a href="https://github.com/srhea/GoldenCheetah/blob/master/contrib/Universal_D2XX0.1.6.dmg?raw=true">here</a>
and install via the terminal. Or if you are not terminal savvy, download an installer that will
perform the installation of the 0.1.6 drivers for you
<a href="http://bugs.goldencheetah.org/attachments/download/248/Install_D2XX_drivers.mpkg.zip">
<a href="https://github.com/srhea/GoldenCheetah/blob/master/contrib/Install_D2XX_drivers.mpkg.zip?raw=true">
here</a>.
<p>

9
doc/wiki.content Normal file
View File

@@ -0,0 +1,9 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Your Page Title</title>
<meta http-equiv="REFRESH" content="0;url=https://github.com/srhea/GoldenCheetah/wiki"></HEAD>
<body>
Redirecting to: <a href="https://github.com/srhea/GoldenCheetah/wiki">https://github.com/srhea/GoldenCheetah/wiki</a>
</body>
</html>

4
doc/wishlist.content
View File

@@ -3,8 +3,8 @@ I wish GoldenCheetah would let me...
</font></big>
<p>If you have a new feature that you'd like to see in GoldenCheetah
please create a new issue on our
<a href=http://bugs.goldencheetah.org/projects/show/goldencheetah>bug/feature
tracker</a>. Instructions for doing so are <a href="bug-tracker.html">here</a>.
<a href="https://github.com/srhea/GoldenCheetah/issues"> issue
tracker</a>.
<p>
Examples of some features are:
<ul>