From a5086dcf7c70326c810906c57c978586e34a5ed0 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Mon, 09 Jun 2014 21:36:43 -0400
Subject: [PATCH] Documentation
---
src/site/siteindex.mkd | 22 ++++++++++++++++++++--
src/site/setup_transport_ssh.mkd | 12 ++++++++++--
src/site/tickets_setup.mkd | 2 +-
src/site/roadmap.mkd | 7 +++----
build.xml | 6 ++++--
src/site/tickets_replication.mkd | 4 ++--
6 files changed, 40 insertions(+), 13 deletions(-)
diff --git a/build.xml b/build.xml
index c405d06..39fdb2e 100644
--- a/build.xml
+++ b/build.xml
@@ -560,6 +560,8 @@
<divider />
<link name="Gitblit GO (Docker)" src="https://registry.hub.docker.com/u/jmoger/gitblit/" />
<divider />
+ <link name="Plugins Registry" src="http://plugins.gitblit.com" />
+ <divider />
<link name="Gitblit Manager" src="${gc.url}manager-${project.releaseVersion}.zip" />
<link name="Federation Client" src="${gc.url}fedclient-${project.releaseVersion}.zip" />
<divider />
@@ -574,7 +576,7 @@
<menu name="links">
<link name="dev.gitblit.com (self-hosted)" src="https://dev.gitblit.com" />
<divider />
- <link name="Plugin Registry" src="http://plugins.gitblit.com" />
+ <link name="Plugins Registry" src="http://plugins.gitblit.com" />
<divider />
<link name="Github" src="${project.scmUrl}" />
<link name="Issues" src="${project.issuesUrl}" />
@@ -860,7 +862,7 @@
<menu name="links">
<link name="dev.gitblit.com (self-hosted)" src="https://dev.gitblit.com" />
<divider />
- <link name="Plugin Registry" src="http://plugins.gitblit.com" />
+ <link name="Plugins Registry" src="http://plugins.gitblit.com" />
<divider />
<link name="Github" src="${project.scmUrl}" />
<link name="Issues" src="${project.issuesUrl}" />
diff --git a/src/site/roadmap.mkd b/src/site/roadmap.mkd
index 03d69df..ea64321 100644
--- a/src/site/roadmap.mkd
+++ b/src/site/roadmap.mkd
@@ -3,7 +3,6 @@
This is not exactly a formal roadmap but it is a priority list of what might be implemented in future releases.
This list is volatile and may not reflect what will be in the next release.
-* **In-Progress**: Integrate an SSH daemon (issue-369)
-* Diff should highlight inserted/removed fragment compared to original line
-* Respect Gerrit branch permissions, if found (issue 36)
-
+* Add support for Project owners/administrators (ticket-75)
+* Add Project create/update pages
+* Integrate improvements for git-flow (ticket-55)
diff --git a/src/site/setup_transport_ssh.mkd b/src/site/setup_transport_ssh.mkd
index 0f35910..c18dac4 100644
--- a/src/site/setup_transport_ssh.mkd
+++ b/src/site/setup_transport_ssh.mkd
@@ -23,14 +23,22 @@
ssh-keygen
+**NOTE:** It is important to note that *ssh-keygen* generates a public/private keypair (e.g. id_rsa and id_rsa.pub). You want to upload the *public* key, which is denoted by the *.pub* file extension.
+
+#### Uploading your public key from the command-line
+
Then you can upload your *public* key right from the command-line.
cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add
cat c:\<userfolder>\.ssh\id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add
-**NOTE:** It is important to note that *ssh-keygen* generates a public/private keypair (e.g. id_rsa and id_rsa.pub). You want to upload the *public* key, which is denoted by the *.pub* file extension.
+#### Uploading your public key through the browser
-Once you've done both of those steps you should be able to execute the following command without a password prompt.
+1. Navigate to your *profile* page from the dropdown user menu.
+2. Click the *SSH Keys* tab and paste your public key into the *Add SSH Key* form.
+3. Click the *Save* button
+
+Once you ave uploaded your public key you should be able to execute the following command without a password prompt.
ssh -l <username> -p 29418 <hostname>
diff --git a/src/site/siteindex.mkd b/src/site/siteindex.mkd
index cc8dc2f..58e18af 100644
--- a/src/site/siteindex.mkd
+++ b/src/site/siteindex.mkd
@@ -1,4 +1,14 @@
<div class="well" style="margin-left:5px;float:right;width:275px;padding: 10px 10px;">
+<script>
+ (function(d, s, id) {
+ var js, fjs = d.getElementsByTagName(s)[0];
+ if (d.getElementById(id)) return;
+ js = d.createElement(s); js.id = id;
+ js.async = true;
+ js.src = "//go.jelastic.com/widgets.js";
+ fjs.parentNode.insertBefore(js, fjs);
+ }(document, 'script', 'jelastic-jssdk'));
+</script>
<div style="text-align:center">
<b>Current Release ${project.releaseVersion} (${project.releaseDate})</b><br/><a href="releasenotes.html">release notes</a>
<div style="padding:5px;"><a style="width:175px;text-decoration:none;" class="btn btn-success" href="%GCURL%gitblit-${project.releaseVersion}.zip">Download Gitblit GO (Windows)</a></div>
@@ -7,7 +17,7 @@
<div style="padding:5px;"><a style="width:175px;text-decoration:none;" class="btn btn-primary" href="%GCURL%manager-${project.releaseVersion}.zip">Download Gitblit Manager</a></div>
<a href='https://bintray.com/gitblit/releases/gitblit/view?source=watch' alt='Get automatic notifications about new "stable" versions'><img src='https://www.bintray.com/docs/images/bintray_badge_color.png'></a>
</div>
-
+<div data-manifest="http://1c57d83a4c5f3a21ec25c050d4c5e37b.app.jelastic.com/xssu/cross/download/RDYYHABkAFJbUVlMMVU7RUtDARgATExFCEBuGS4jdQJKRUsEDwIBQmNTTEBI" data-width="280" data-theme="flat-blue" data-text="Get it hosted now!" data-tx-empty="Type your email and click the button" data-tx-invalid-email="Invalid email, please check the spelling" data-tx-error="An error has occurred, please try again later" data-tx-success="Check your email" class="je-app" ></div>
<div style="padding-top:5px;">
<table class="table condensed-table">
<tbody>
@@ -46,11 +56,19 @@
Gitblit can be used as a complete Git stack for cloning, pushing, and repository access control.
Gitblit can be used without any other Git tooling (including actual Git) or it can cooperate with your established tools.
+### All Transports
+
+The SSH, HTTP, & GIT protocols are supported and ready-to-go out of the box.
+
+### Issue tracking with branch-based pull requests
+
+Gitblit blends elements of GitHub, BitBucket, and Gerrit to provide a streamlined collaboration workflow based on branches within the primary repository.
+
### Easy Remote Management
Administrators can create and manage all repositories, user accounts, and teams from the *Web UI*.
Administrators can create and manage all repositories, user accounts, and teams from the *JSON RPC interface* using the [Gitblit Manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) or your own custom tooling.
-Administrators can create and manage all repositories, user accounts, and teams from the *command-line* using the [Powertools plugin](https://github.com/gitblit/gitblit-powertools-plugin).
+Administrators can create and manage all repositories, user accounts, and teams from the *command-line* using SSH & the [Powertools plugin](https://github.com/gitblit/gitblit-powertools-plugin).
### Integration with Your Infrastructure
diff --git a/src/site/tickets_replication.mkd b/src/site/tickets_replication.mkd
index a72df27..60f12cf 100644
--- a/src/site/tickets_replication.mkd
+++ b/src/site/tickets_replication.mkd
@@ -145,9 +145,9 @@
migrate-tickets com.gitblit.tickets.RedisTicketService c:\gitblit-data
-##### Gitblit WAR/Express
+##### Gitblit WAR
-Gitblit WAR/Express does not ship with anything other than the WAR, but you can still migrate tickets offline with a little extra effort.
+Gitblit WAR does not ship with anything other than the WAR, but you can still migrate tickets offline with a little extra effort.
*Windows*
diff --git a/src/site/tickets_setup.mkd b/src/site/tickets_setup.mkd
index aeecbeb..f70d75c 100644
--- a/src/site/tickets_setup.mkd
+++ b/src/site/tickets_setup.mkd
@@ -109,7 +109,7 @@
#### Milestones
-Milestones are a way to group tickets together. Currently milestones are specified at the repository level and are stored in the repository git config file. Gitblit's internal architecture has all the methods necessary to maintain milestones, but this functionality is not yet exposed through the web ui. For now you will have to control milestones manually with a text editor.
+Milestones are a way to group tickets together. Milestones are specified for each repository and are stored in the repository git config file. Repository owners may create milestones through the web ui in the *Tickets* page on the *Milestones* tab.
[milestone "v1.5.0"]
status = Open
--
Gitblit v1.9.1