Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Sohn2011-06-22 00:33:28 +0000
committerMatthias Sohn2011-06-22 01:04:48 +0000
commit54e1b7949bd8d0340a42c2934a9c8690ec0124ac (patch)
tree63f9e9ffcab4e24f1266353a7ce0c2bcf0ee1801
parent219aa7eb22b4c163ca8fea8edfc78a793ccc1a3b (diff)
downloadegit-github-54e1b7949bd8d0340a42c2934a9c8690ec0124ac.tar.gz
egit-github-54e1b7949bd8d0340a42c2934a9c8690ec0124ac.tar.xz
egit-github-54e1b7949bd8d0340a42c2934a9c8690ec0124ac.zip
Update egit-github documentation for 1.0
Also add the documentation bundle to the github-feature to include it in the installation. Change-Id: I2dfc6e1db6cbd785453ae2e3cd2dfc5b9ddc24dd Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
-rw-r--r--org.eclipse.mylyn.github-feature/feature.xml7
-rw-r--r--org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/Updating-This-Document.html55
-rw-r--r--org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/User-Guide.html157
-rw-r--r--org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynGistEditor.pngbin0 -> 112422 bytes
-rw-r--r--org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueEditor.pngbin0 -> 77941 bytes
-rw-r--r--org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueQueryPage.pngbin0 -> 33549 bytes
-rw-r--r--org.eclipse.mylyn.github.doc/help/images/home.gifbin0 -> 582 bytes
-rw-r--r--org.eclipse.mylyn.github.doc/help/images/next.gifbin0 -> 327 bytes
-rw-r--r--org.eclipse.mylyn.github.doc/help/images/prev.gifbin0 -> 327 bytes
-rw-r--r--org.eclipse.mylyn.github.doc/help/images/topiclabel/git48.pngbin0 -> 2081 bytes
10 files changed, 219 insertions, 0 deletions
diff --git a/org.eclipse.mylyn.github-feature/feature.xml b/org.eclipse.mylyn.github-feature/feature.xml
index c0f546b3..e53ad391 100644
--- a/org.eclipse.mylyn.github-feature/feature.xml
+++ b/org.eclipse.mylyn.github-feature/feature.xml
@@ -70,4 +70,11 @@
install-size="0"
version="0.0.0"
unpack="false"/>
+
+ <plugin
+ id="org.eclipse.mylyn.github.doc"
+ download-size="0"
+ install-size="0"
+ version="0.0.0"/>
+
</feature>
diff --git a/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/Updating-This-Document.html b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/Updating-This-Document.html
new file mode 100644
index 00000000..90842e70
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/Updating-This-Document.html
@@ -0,0 +1,55 @@
+<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>Mylyn GitHub Connector User Guide - Updating This Document</title>
+ <link type="text/css" rel="stylesheet" href="../../../book.css"/>
+ </head>
+ <body>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <th style="width: 100%" align="center" colspan="3">Updating This Document</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="User-Guide.html" title="Mylyn GitHub Connector User Guide">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right"></td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">Mylyn GitHub Connector User Guide</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top"></td>
+ </tr>
+ </table><hr/>
+ <h1 id="Updating_This_Document">Updating This Document</h1>
+ <p> This document is maintained in a collaborative wiki. If you wish to
+ update or modify this document please visit
+
+ <a href="http://wiki.eclipse.org/EGit/GitHub/User_Guide" target="egit_github_external">http://wiki.eclipse.org/EGit/GitHub/User_Guide</a>
+ </p><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="User-Guide.html" title="Mylyn GitHub Connector User Guide">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="Mylyn GitHub Connector User Guide">
+ <img alt="Mylyn GitHub Connector User Guide" border="0" src="../../../images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right"></td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">Mylyn GitHub Connector User Guide</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top"></td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/User-Guide.html b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/User-Guide.html
new file mode 100644
index 00000000..6eef8bf5
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/User-Guide.html
@@ -0,0 +1,157 @@
+<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>Mylyn GitHub Connector User Guide</title>
+ <link type="text/css" rel="stylesheet" href="../../../book.css"/>
+ </head>
+ <body>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <th style="width: 100%" align="center" colspan="3">Mylyn GitHub Connector User Guide</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left"></td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right">
+ <a href="Updating-This-Document.html" title="Updating This Document">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top"></td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Updating This Document</td>
+ </tr>
+ </table><hr/>
+ <h2 id="Overview">Overview</h2>
+ <p>The EGit Mylyn GitHub connector supports creating task repositories for working with
+ <a href="http://www.github.com" target="egit_github_external">GitHub</a> issues and
+ <a href="http://gist.github.com" target="egit_github_external">Gists</a>. A GitHub issue task repository is required for each GitHub project repository you want to access issues for. A single Gist repository allows you to access all Gists on
+ <a href="http://gist.github.com" target="egit_github_external">http://gist.github.com</a>.
+ </p>
+ <p>The latest version of the EGit Mylyn GitHub connector can be installed from following update site:</p>
+ <p>
+ <a href="http://download.eclipse.org/egit/github/updates-nightly" target="egit_github_external">http://download.eclipse.org/egit/github/updates-nightly</a>
+ </p>
+ <h2 id="Getting_Started">Getting Started</h2>
+ <p>The Mylyn GitHub connector supports bulk adding all your GitHub repositories to the Mylyn Task Repositorities view.</p>
+ <ol>
+ <li>Select
+ <b>File &gt; Import...</b>
+ </li>
+ <li>Select the
+ <i>GitHub Task Repositories</i> node under the
+ <i>Tasks</i> category
+ </li>
+ <li>Select
+ <b>Next</b>
+ </li>
+ <li>Enter your GitHub login name and password on the credentials wizard page</li>
+ <li>Select
+ <b>Next</b>
+ </li>
+ <li>Check all the GitHub repositories that you want to access issues from.</li>
+ <li>Select
+ <b>Finish</b>
+ </li>
+ <li>Open the
+ <i>Task Repositories</i> view to browse the newly added task repositories and add queries or create new tasks.
+ </li>
+ </ol>
+ <h2 id="Issues">Issues</h2>
+ <h3 id="Queries">Queries</h3>
+ <p>GitHub issue task repositories support creating queries that filter by the following fields:</p>
+ <ul>
+ <li>State (open or closed)</li>
+ <li>Milestones</li>
+ <li>Mentions</li>
+ <li>Assignee</li>
+ <li>Labels</li>
+ </ul>
+ <p>Note that when multiple filters are used in the same query the returned issues will match
+ <b>all</b> of the filters. The minimum required for a valid query is at least one status selected and a non-empty title.
+ </p>
+ <p>
+ <img align="middle" border="0" src="images/GitHubMylynIssueQueryPage.png"/>
+ </p>
+ <h3 id="Issue_Editor">Issue Editor</h3>
+ <p>The GitHub issue task editor supports the following:</p>
+ <ul>
+ <li>Editing the title &amp; description</li>
+ <li>Adding a new comment</li>
+ <li>Closing &amp; reopening the issue from the
+ <i>Actions</i> section
+ </li>
+ <li>Assigning the issue to someone from the
+ <i>People</i> section
+ </li>
+ <li>Adding and removing labels from the
+ <i>Attributes</i> section
+ </li>
+ <li>Updating the milestone from the
+ <i>Attributes</i> section
+ </li>
+ </ul>
+ <p>
+ <img align="middle" border="0" src="images/GitHubMylynIssueEditor.png"/>
+ </p>
+ <h2 id="Gists">Gists</h2>
+ <h3 id="Creating">Creating</h3>
+ <p>Gists can be created by selecting text in a editor or files in an explorer and selecting either the
+ <i>GitHub</i> &gt;
+ <b>Create Private Gist</b> or
+ <i>GitHub</i> &gt;
+ <b>Create Public Gist</b> context menu. The Gist will be created in a background job and a notification popup will display with a link to open the newly created Gist.
+ </p>
+ <h3 id="Queries_2">Queries</h3>
+ <p>Gist queries only support filtering by a specified GitHub login name.</p>
+ <h3 id="Gist_Editor">Gist Editor</h3>
+ <p>The task editor for Gists supports the following:</p>
+ <ul>
+ <li>Editing the description</li>
+ <li>Adding a new comment </li>
+ <li>Opening the files in a gist in an editor</li>
+ <li>Adding new files to the gist</li>
+ <li>Replacing the content of a file currently in the gist</li>
+ <li>Cloning the gist to a local Eclipse project</li>
+ </ul>
+ <p>
+ <img align="middle" border="0" src="images/GitHubMylynGistEditor.png"/>
+ </p>
+ <h2 id="Frequently_Asked_Questions_.28FAQ.29">Frequently Asked Questions (FAQ)</h2>
+ <ul>
+ <li>Does the connector support GitHub API tokens?
+ <ul>
+ <li>
+ <b>No</b>, API tokens are no longer supported by the GitHub v3 API which the connector uses for requests.
+ </li>
+ </ul>
+ </li>
+ <li>Are GitHub API requests made over HTTPS?
+ <ul>
+ <li>
+ <b>Yes</b>, all requests made through the GitHub API are over HTTPS.
+ </li>
+ </ul>
+ </li>
+ </ul><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left"></td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right">
+ <a href="Updating-This-Document.html" title="Updating This Document">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top"></td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Updating This Document</td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynGistEditor.png b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynGistEditor.png
new file mode 100644
index 00000000..07e0c9df
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynGistEditor.png
Binary files differ
diff --git a/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueEditor.png b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueEditor.png
new file mode 100644
index 00000000..eb7af3b9
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueEditor.png
Binary files differ
diff --git a/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueQueryPage.png b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueQueryPage.png
new file mode 100644
index 00000000..2cebedd3
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/EGit/GitHub/User_Guide/images/GitHubMylynIssueQueryPage.png
Binary files differ
diff --git a/org.eclipse.mylyn.github.doc/help/images/home.gif b/org.eclipse.mylyn.github.doc/help/images/home.gif
new file mode 100644
index 00000000..4472e8ce
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/images/home.gif
Binary files differ
diff --git a/org.eclipse.mylyn.github.doc/help/images/next.gif b/org.eclipse.mylyn.github.doc/help/images/next.gif
new file mode 100644
index 00000000..e2f8c3e1
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/images/next.gif
Binary files differ
diff --git a/org.eclipse.mylyn.github.doc/help/images/prev.gif b/org.eclipse.mylyn.github.doc/help/images/prev.gif
new file mode 100644
index 00000000..4fb41501
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/images/prev.gif
Binary files differ
diff --git a/org.eclipse.mylyn.github.doc/help/images/topiclabel/git48.png b/org.eclipse.mylyn.github.doc/help/images/topiclabel/git48.png
new file mode 100644
index 00000000..ed944ac3
--- /dev/null
+++ b/org.eclipse.mylyn.github.doc/help/images/topiclabel/git48.png
Binary files differ

Back to the top