]> source.dussan.org Git - gitblit.git/commitdiff
Documentation
authorJames Moger <james.moger@gitblit.com>
Tue, 10 Jun 2014 01:36:43 +0000 (21:36 -0400)
committerJames Moger <james.moger@gitblit.com>
Tue, 10 Jun 2014 01:36:43 +0000 (21:36 -0400)
build.xml
src/site/roadmap.mkd
src/site/setup_transport_ssh.mkd
src/site/siteindex.mkd
src/site/tickets_replication.mkd
src/site/tickets_setup.mkd

index c405d06d7b8361b4992169cf334d55e6f93dc2a5..39fdb2e72be46bb9eab6c38a0f0f8c420dcbe58b 100644 (file)
--- a/build.xml
+++ b/build.xml
                                        <divider />\r
                                        <link name="Gitblit GO (Docker)" src="https://registry.hub.docker.com/u/jmoger/gitblit/" />\r
                                        <divider />\r
+                                       <link name="Plugins Registry" src="http://plugins.gitblit.com" />\r
+                                       <divider />\r
                                        <link name="Gitblit Manager" src="${gc.url}manager-${project.releaseVersion}.zip" />\r
                                        <link name="Federation Client" src="${gc.url}fedclient-${project.releaseVersion}.zip" />\r
                                        <divider />\r
                                <menu name="links">\r
                                        <link name="dev.gitblit.com (self-hosted)" src="https://dev.gitblit.com" />\r
                                        <divider />\r
-                                       <link name="Plugin Registry" src="http://plugins.gitblit.com" />\r
+                                       <link name="Plugins Registry" src="http://plugins.gitblit.com" />\r
                                        <divider />\r
                                        <link name="Github" src="${project.scmUrl}" />\r
                                        <link name="Issues" src="${project.issuesUrl}" />\r
                                        <menu name="links">\r
                                                <link name="dev.gitblit.com (self-hosted)" src="https://dev.gitblit.com" />\r
                                                <divider />\r
-                                               <link name="Plugin Registry" src="http://plugins.gitblit.com" />\r
+                                               <link name="Plugins Registry" src="http://plugins.gitblit.com" />\r
                                                <divider />\r
                                                <link name="Github" src="${project.scmUrl}" />\r
                                                <link name="Issues" src="${project.issuesUrl}" />\r
index 03d69dfbb9e602a93e4e241aa15cdd2990aef7a7..ea6432187ce8734a4f0c662e58d7518ae041356c 100644 (file)
@@ -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.  \r
 This list is volatile and may not reflect what will be in the next release.\r
 \r
-* **In-Progress**: Integrate an SSH daemon (issue-369)\r
-* Diff should highlight inserted/removed fragment compared to original line\r
-* Respect Gerrit branch permissions, if found (issue 36)\r
-\r
+* Add support for Project owners/administrators (ticket-75)\r
+* Add Project create/update pages\r
+* Integrate improvements for git-flow (ticket-55)\r
index 0f359105488b4d0ee8bff8248f69167ada139a9c..c18dac46edab6934203f15b98c77a03dcc01eaa9 100644 (file)
@@ -23,14 +23,22 @@ First you'll need to create an SSH key pair, if you don't already have one or if
 \r
     ssh-keygen\r
 \r
+**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.\r
+\r
+#### Uploading your public key from the command-line\r
+\r
 Then you can upload your *public* key right from the command-line.\r
 \r
     cat ~/.ssh/id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add\r
     cat c:\<userfolder>\.ssh\id_rsa.pub | ssh -l <username> -p 29418 <hostname> keys add\r
 \r
-**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.\r
+#### Uploading your public key through the browser\r
+\r
+1. Navigate to your *profile* page from the dropdown user menu.\r
+2. Click the *SSH Keys* tab and paste your public key into the *Add SSH Key* form.\r
+3. Click the *Save* button\r
 \r
-Once you've done both of those steps you should be able to execute the following command without a password prompt.\r
+Once you ave uploaded your public key you should be able to execute the following command without a password prompt.\r
 \r
     ssh -l <username> -p 29418 <hostname>\r
 \r
index cc8dc2fae08b694fe6d6c7873a335459fc14f898..58e18af156c9ff299291551958f16f1b9acc98e0 100644 (file)
@@ -1,4 +1,14 @@
 <div class="well" style="margin-left:5px;float:right;width:275px;padding: 10px 10px;">\r
+<script>\r
+   (function(d, s, id) {\r
+       var js, fjs = d.getElementsByTagName(s)[0];\r
+       if (d.getElementById(id)) return;\r
+       js = d.createElement(s); js.id = id;\r
+       js.async = true;\r
+       js.src = "//go.jelastic.com/widgets.js";\r
+       fjs.parentNode.insertBefore(js, fjs);\r
+   }(document, 'script', 'jelastic-jssdk'));\r
+</script>\r
 <div style="text-align:center">\r
 <b>Current Release ${project.releaseVersion} (${project.releaseDate})</b><br/><a href="releasenotes.html">release notes</a>\r
 <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>\r
@@ -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>\r
                <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>\r
        </div>\r
-\r
+<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>\r
        <div style="padding-top:5px;">\r
        <table class="table condensed-table">\r
                <tbody>\r
@@ -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.  \r
 Gitblit can be used without any other Git tooling (including actual Git) or it can cooperate with your established tools.\r
 \r
+### All Transports\r
+\r
+The SSH, HTTP, & GIT protocols are supported and ready-to-go out of the box.\r
+\r
+### Issue tracking with branch-based pull requests\r
+\r
+Gitblit blends elements of GitHub, BitBucket, and Gerrit to provide a streamlined collaboration workflow based on branches within the primary repository.\r
+\r
 ### Easy Remote Management\r
 \r
 Administrators can create and manage all repositories, user accounts, and teams from the *Web UI*.  \r
 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. \r
-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).\r
+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).\r
 \r
 ### Integration with Your Infrastructure\r
 \r
index a72df27f3138ad17f0e48afd62cbb44856bf7f11..60f12cf6b50181f854cd3695101c195d71f6b6fc 100644 (file)
@@ -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*
 
index aeecbeb1df028968a9338a9b458142b1989145db..f70d75cd7fbff9fc1839e9127fff789b245e6643 100644 (file)
@@ -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