From: James Moger Date: Tue, 10 Jun 2014 01:36:43 +0000 (-0400) Subject: Documentation X-Git-Tag: v1.6.0~23 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a5086dcf7c70326c810906c57c978586e34a5ed0;p=gitblit.git Documentation --- diff --git a/build.xml b/build.xml index c405d06d..39fdb2e7 100644 --- a/build.xml +++ b/build.xml @@ -560,6 +560,8 @@ + + @@ -574,7 +576,7 @@ - + @@ -860,7 +862,7 @@ - + diff --git a/src/site/roadmap.mkd b/src/site/roadmap.mkd index 03d69dfb..ea643218 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 0f359105..c18dac46 100644 --- a/src/site/setup_transport_ssh.mkd +++ b/src/site/setup_transport_ssh.mkd @@ -23,14 +23,22 @@ First you'll need to create an SSH key pair, if you don't already have one or if 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 -p 29418 keys add cat c:\\.ssh\id_rsa.pub | ssh -l -p 29418 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 + +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've done both of those steps you should be able to execute the following command without a password prompt. +Once you ave uploaded your public key you should be able to execute the following command without a password prompt. ssh -l -p 29418 diff --git a/src/site/siteindex.mkd b/src/site/siteindex.mkd index cc8dc2fa..58e18af1 100644 --- a/src/site/siteindex.mkd +++ b/src/site/siteindex.mkd @@ -1,4 +1,14 @@
+
Current Release ${project.releaseVersion} (${project.releaseDate})
release notes @@ -7,7 +17,7 @@
- +
@@ -46,11 +56,19 @@ Gitblit can be used as a dumb repository viewer with no administrative controls 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 a72df27f..60f12cf6 100644 --- a/src/site/tickets_replication.mkd +++ b/src/site/tickets_replication.mkd @@ -145,9 +145,9 @@ For example, this would migrate tickets from the current ticket service configur 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 aeecbeb1..f70d75cd 100644 --- a/src/site/tickets_setup.mkd +++ b/src/site/tickets_setup.mkd @@ -109,7 +109,7 @@ Gitblit has a simple review scoring mechanism designed to indicate overall impre #### 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