mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-08-26 22:37:29 +02:00
Streamline documentation for Gatsby support
This commit is contained in:
Konstantin Schaper
@@ -1,4 +1,6 @@
|
||||
# Extension Points
|
||||
---
|
||||
title: Extension Points
|
||||
---
|
||||
|
||||
- [AuthenticationHandler](http://docs.scm-manager.org/apidocs/latest/sonia/scm/web/security/AuthenticationHandler.html)
|
||||
- [AuthenticationListener](http://docs.scm-manager.org/apidocs/latest/sonia/scm/web/security/AuthenticationListener.html)
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
Moved to [State of SCM-Manager 2 development](State of SCM-Manager 2 development.md)
|
||||
@@ -1,4 +1,6 @@
|
||||
## Permissions
|
||||
---
|
||||
title: Permissions
|
||||
---
|
||||
|
||||
SCM-Manager knows three different types of repository permissions:
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# RPM and DEB packages
|
||||
---
|
||||
title: RPM and DEB packages
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
Since version 1.39, SCM-Manager is delivered as RPM and DEB package. The package are generated with the [nativepkg-maven-plugin](https://github.com/sdorra/nativepkg-maven-plugin). The following table shows the directory structure which will be created by the packages:
|
||||
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
# State of SCM-Manager 2 development
|
||||
The development of SCM-Manager 2.0.0 is organised in [Trello Boards](https://trello.com/scmmanager).
|
||||
|
||||
## [Milestone 1](https://trello.com/b/oit1MD92/scm-manager-2-0-0-milestone-1)
|
||||
|
||||
### Main goals
|
||||
* remove deprecated and unused stuff
|
||||
* remove old style listeners
|
||||
* replace [guava eventbus](https://code.google.com/p/guava-libraries/wiki/EventBusExplained) with [legman](https://github.com/sdorra/legman)
|
||||
* introduce new plugin structure
|
||||
* offline plugin installation/updates/deinstallation
|
||||
* use java 7 as default
|
||||
* use of [annotation processors](http://docs.oracle.com/javase/7/docs/api/javax/annotation/processing/Processor.html) instead of classpath scanning
|
||||
* move non core modules (plugin-backend, maven plugins, etc.) to separate repositories
|
||||
|
||||
## [Milestone 2](https://trello.com/b/Afb3hoJ9/scm-manager-2-0-0-milestone-2)
|
||||
|
||||
### Main goals
|
||||
* use [apache shiro](http://shiro.apache.org/) everywhere
|
||||
* improve authentication
|
||||
* improve user and group management
|
||||
* use permission instead of roles
|
||||
|
||||
## [Milestone 3](https://trello.com/b/eLvqTGGe/scm-manager-2-0-0-milestone-3)
|
||||
|
||||
### Main goals
|
||||
* completely new designed rest api
|
||||
|
||||
## Milestone 4
|
||||
|
||||
### Main goals
|
||||
* completely new user interface
|
||||
|
||||
## Milestone 5
|
||||
|
||||
### Main goals
|
||||
* improve repository api
|
||||
@@ -1,4 +1,6 @@
|
||||
### Active Directory Plugin
|
||||
---
|
||||
title: Active Directory Plugin
|
||||
---
|
||||
|
||||
- Connect your Windows machine to your local Active Directory
|
||||
- Log in as a user of that directory
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: SCM-Server and Apache mod\_jk
|
||||
subtitle: Main documentation page
|
||||
subtitle: Setting up SCM-Manager with Apache Tomcat
|
||||
---
|
||||
|
||||
### Apache Configuration
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# SCM-Server and Apache mod\_proxy
|
||||
---
|
||||
title: SCM-Server and Apache mod\_proxy
|
||||
subtitle: Setting up SCM-Manager behind a reverse proxy
|
||||
---
|
||||
|
||||
### Apache configuration
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Applicationserver
|
||||
---
|
||||
title: Applicationserver
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
## Tomcat
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Branch Write Protect Plugin
|
||||
---
|
||||
title: Branch Write Protect Plugin
|
||||
---
|
||||
|
||||
### Installation
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Building SCM-Manager from source
|
||||
---
|
||||
title: Building SCM-Manager from source
|
||||
---
|
||||
|
||||
### Software Requirements
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Code Snippets
|
||||
---
|
||||
title: Code Snippets
|
||||
---
|
||||
|
||||
### User Interface
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Command line client
|
||||
---
|
||||
title: Command line client
|
||||
---
|
||||
|
||||
You can download the command line client from
|
||||
[here](http://www.scm-manager.org/download/) (the scm-cli-client).
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Configure Eclipse
|
||||
---
|
||||
title: Configuring Eclipse
|
||||
---
|
||||
|
||||
There are multiple approaches to using Maven projects within Eclipse. If
|
||||
you use an approach that isn\'t listed here, feel free to add it.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Unix Daemons and Windows Services
|
||||
---
|
||||
title: Unix Daemons and Windows Services
|
||||
---
|
||||
|
||||
**Note**: If you are using a 64Bit operating system you should use a 64Bit JavaVirtualMachine as well
|
||||
([#74](https://github.com/scm-manager/scm-manager/issues/74) or
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Download Archive
|
||||
---
|
||||
title: Download Archive
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
### SCM-Server 1.59 (standalone)
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Download latest Snapshot release
|
||||
---
|
||||
title: Snapshot Releases
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
### SCM-Server 1.61 SNAPSHOT (standalone)
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Download
|
||||
---
|
||||
title: Stable
|
||||
---
|
||||
|
||||
The download page has moved to <http://www.scm-manager.org/download/>
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Frequently Asked Questions
|
||||
---
|
||||
title: FAQ
|
||||
---
|
||||
|
||||
### What are the username and the password in the default installation?
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Getting started
|
||||
subtitle: How to install and configure SCM-Manager
|
||||
---
|
||||
|
||||
# Getting started
|
||||
|
||||
### Install Java
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
# SCM-Manager with GlassFish
|
||||
|
||||
To use SCM-Manager 1.6 and above with GlassFish 3.x you have to add a
|
||||
JVM-Option to the GlassFish configuration. Please follow the steps
|
||||
below.
|
||||
|
||||
Open the GlassFish Admin-Console (http://yourserver:4848), login as
|
||||
admin user, goto Configuration-\>JVM Settings, switch to the JVM Options
|
||||
tab and add the following JVM-Option:
|
||||
|
||||
```bash
|
||||
-Dcom.sun.enterprise.overrideablejavaxpackages=javax.ws.rs,javax.ws.rs.core,javax.ws.rs.ext
|
||||
```
|
||||
|
||||
Restart the GlassFish-Server.
|
||||
|
||||
Source:
|
||||
<http://jersey.java.net/nonav/documentation/latest/glassfish.html>
|
||||
@@ -1,4 +1,6 @@
|
||||
# Incompatible subversion db format
|
||||
---
|
||||
title: Incompatible subversion db format
|
||||
---
|
||||
|
||||
SCM-Manager versions prior to 1.36 are creating incompatible subversion repositories, if the subversion option "with 1.7 Compatible" is enabled. This subversion repositories are neither compatible with svn 1.7 nor svn 1.8. These repositories are marked as unhealthy by SCM-Manager version 1.36 and above.
|
||||
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
# How to create your own plugin
|
||||
|
||||
### Software Requirements
|
||||
|
||||
- JDK 1.7 or higher
|
||||
([download](http://www.oracle.com/technetwork/java/index.html))
|
||||
- Maven 3 or higher ([download](http://maven.apache.org/))
|
||||
|
||||
### Create plugin
|
||||
|
||||
```bash
|
||||
mvn archetype:generate\
|
||||
-DarchetypeGroupId=sonia.scm.maven\
|
||||
-DarchetypeArtifactId=scm-plugin-archetype\
|
||||
-DarchetypeVersion=1.60\
|
||||
-DarchetypeRepository=http://maven.scm-manager.org/nexus/content/groups/public/
|
||||
```
|
||||
### Test the plugin
|
||||
|
||||
```bash
|
||||
mvn scmp:run
|
||||
```
|
||||
|
||||
### Samples
|
||||
|
||||
- [Hello World](https://bitbucket.org/sdorra/scm-manager/src/1.x/scm-samples/scm-sample-hello/)
|
||||
- [Authentication Plugin](https://bitbucket.org/sdorra/scm-manager/src/1.x/scm-samples/scm-sample-auth/)
|
||||
|
||||
### Further reading
|
||||
|
||||
- [Injection framework - Google Guice](http://code.google.com/p/google-guice/)
|
||||
- [Restful WebService - Jersey](http://jersey.java.net/nonav/documentation/latest/user-guide.html)
|
||||
- [ XML transformation - JAXB](http://jaxb.java.net/guide/)
|
||||
- [User interface - Ext JS](http://www.sencha.com/products/extjs3/)
|
||||
|
||||
### Questions/Help
|
||||
|
||||
If you have questions or you need help, please write to the mailing
|
||||
list: <https://groups.google.com/forum/#!forum/scmmanager>
|
||||
@@ -1,4 +1,6 @@
|
||||
# SCM-Manager on IIS Helicon
|
||||
---
|
||||
title: SCM-Manager on IIS Helicon
|
||||
---
|
||||
First of all this setup is not recommended, because there were a lot of problems with it and it was never tested by the development team of SCM-Manager. However there are several working installation out there. But there some pitfalls:
|
||||
|
||||
**Problem description:**
|
||||
|
||||
@@ -79,7 +79,7 @@ repositories over http.
|
||||
- [Configuring Eclipse projects for SCM-Manager](configure-eclipse.md)
|
||||
- [Plugin Descriptor](plugin-descriptor.md)
|
||||
- [ExtensionPoints](ExtensionPoints.md)
|
||||
- [How to create your own plugin](howto-create-a-plugin.md)
|
||||
- [How to create your own plugin](content/docs/1.60.x/en/how-to-create-a-plugin.md)
|
||||
- [Injection Objects](injectionObjects.md)
|
||||
- [API documentation](http://docs.scm-manager.org/apidocs/latest/)
|
||||
- [WebService documentation](http://docs.scm-manager.org/restdocs/current/)
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# Injection Objects
|
||||
|
||||
---
|
||||
title: Injection Objects
|
||||
---
|
||||
- [AdministrationContext](http://docs.scm-manager.org/apidocs/latest/sonia/scm/web/security/AdministrationContext.html)
|
||||
- [AuthenticationManager](http://docs.scm-manager.org/apidocs/latest/sonia/scm/web/security/AuthenticationManager.html)
|
||||
- [CGIExecutorFactory](http://docs.scm-manager.org/apidocs/latest/sonia/scm/web/cgi/CGIExecutorFactory.html)
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Java Client API
|
||||
---
|
||||
title: Java Client API
|
||||
---
|
||||
|
||||
### Maven
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# scm-jenkins-plugin
|
||||
---
|
||||
title: SCM-Jenkins-Plugin
|
||||
---
|
||||
|
||||
The jenkins plugin will ping your Jenkins CI server when a new commit is
|
||||
pushed to SCM-Manager. In SCM-Manager exists two differnt methods to
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# scm-jira-plugin
|
||||
---
|
||||
title: Jira Plugin
|
||||
---
|
||||
|
||||
The plugin enables the following features to integrate Atlassian JIRA to
|
||||
SCM-Manager:
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# scm-mail-plugin
|
||||
---
|
||||
title: Mail Plugin
|
||||
---
|
||||
|
||||
The mail plugin provides an central api for sending e-mails. This api
|
||||
can be used by other plugins.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# scm-mantisbt-plugin
|
||||
---
|
||||
title: Mantisbt Plugin
|
||||
---
|
||||
|
||||
The plugin enables the following features to integrate [MantisBT](https://www.mantisbt.org/) to SCM-Manager:
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Clone empty repository
|
||||
---
|
||||
title: Cloning an empty repository
|
||||
---
|
||||
|
||||
```http
|
||||
GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Push bookmark
|
||||
---
|
||||
title: Push bookmark
|
||||
---
|
||||
|
||||
```http
|
||||
GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Push multiple branches to new repository
|
||||
---
|
||||
title: Push multiple branches to new repository
|
||||
---
|
||||
|
||||
```http
|
||||
GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Push multiple branches
|
||||
---
|
||||
title: Push multiple branches
|
||||
---
|
||||
|
||||
```http
|
||||
GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Push single changeset
|
||||
---
|
||||
title: Push single changeset
|
||||
---
|
||||
|
||||
```http
|
||||
GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1.
|
||||
|
||||
@@ -1,10 +1,75 @@
|
||||
- section: Getting started
|
||||
entries:
|
||||
- /getting-started/
|
||||
- /applicationserver/
|
||||
- /iis-helicon/
|
||||
- /nginx/
|
||||
- /apache/apache-mod_jk/
|
||||
- /apache/apache-mod_proxy/
|
||||
- /daemons/
|
||||
- /upgrade/
|
||||
- /faq/
|
||||
|
||||
- section: Plugin Development
|
||||
- section: Downloads
|
||||
entries:
|
||||
- /plugin-development/create/
|
||||
- /plugin-development/i18n/
|
||||
- /plugin-development/publish/
|
||||
- /RPM and DEB packages/
|
||||
- /download/
|
||||
- /download-snapshot-release/
|
||||
- /download-archive/
|
||||
|
||||
- section: Release Notes
|
||||
entries:
|
||||
- /release-notes/
|
||||
- /release notes 1.39 - 1.20/
|
||||
- /release notes 1.19 - 1.0/
|
||||
|
||||
- section: Administration
|
||||
entries:
|
||||
- /command-line-client/
|
||||
- /scm-server-ssl/
|
||||
- /Permissions/
|
||||
- /rv-plugin-comparison/
|
||||
- /healthchecks/svn-incompatible-dbformat/
|
||||
|
||||
- section: Mercurial
|
||||
entries:
|
||||
- /mercurial/clone-empty/
|
||||
- /mercurial/push-bookmark/
|
||||
- /mercurial/push-multiple-branches/
|
||||
- /mercurial/push-multiple-branches-to-new/
|
||||
- /mercurial/push-single-changeset/
|
||||
|
||||
- section: Plugins
|
||||
entries:
|
||||
- /scm-plugins/
|
||||
- /how-to-create-a-plugin/
|
||||
- /plugin-descriptor/
|
||||
- /active-directory-plugin/
|
||||
- /branchwp-plugin/
|
||||
- /pathwp-plugin/
|
||||
- /jira-plugin/
|
||||
- /mail-plugin/
|
||||
- /mantisbt-plugin/
|
||||
- /redmine-plugin/
|
||||
- /scheduler-plugin/
|
||||
- /trac-plugin/
|
||||
- /webhook-plugin/
|
||||
- /jenkins-plugin/
|
||||
|
||||
- section: Development
|
||||
entries:
|
||||
- /configure-eclipse/
|
||||
- /build-from-source/
|
||||
- /java-client-api/
|
||||
- /ExtensionPoints/
|
||||
- /injectionObjects/
|
||||
|
||||
- section: Examples
|
||||
entries:
|
||||
- /screens/
|
||||
- /code-snippets/
|
||||
- /snippet-authentication/
|
||||
- /snippet-config-group/
|
||||
- /snippet-extend-navigation/
|
||||
- /snippet-repository-tab/
|
||||
- /subrepositories/
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# SCM-Server and Nginx
|
||||
---
|
||||
title: SCM-Server and Nginx
|
||||
---
|
||||
|
||||
## Nginx configuration
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Path Write Protect Plugin
|
||||
---
|
||||
title: Path Write Protect Plugin
|
||||
---
|
||||
|
||||
### Installation
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Plugin Descriptor
|
||||
---
|
||||
title: Plugin Descriptor
|
||||
---
|
||||
|
||||
The plugin descriptor contains informations and instructions for the
|
||||
scm-manager to integrate the plugin. The descriptor is located at
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Redmine Plugin
|
||||
---
|
||||
title: Redmine Plugin
|
||||
---
|
||||
|
||||
Is based on [scm-jira-plugin](jira-plugin.md).
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Release Notes 1.19 - 1.0
|
||||
---
|
||||
title: Release Notes 1.19 - 1.0
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
## SCM-Manager 1.19
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Release Notes 1.39 - 1.20
|
||||
---
|
||||
title: Release Notes 1.39 - 1.20
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
SCM-Manager 1.39
|
||||
----------------
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Release Notes 1.60 - 1.40
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
**note**
|
||||
|
||||
- Versions prior to 1.36 are creating incompatible subversion
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Revision Control Plugin Comparison
|
||||
---
|
||||
title: Revision Control Plugin Comparison
|
||||
---
|
||||
|
||||
| Plugin Name | Name | Core-Plugin | Requirements | Url |
|
||||
| --- | --- | --- | --- | --- |
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# scm-scheduler-plugin
|
||||
---
|
||||
title: Scheduler Plugin
|
||||
---
|
||||
|
||||
The scheduler plugin provides an api for other plugins to execute scheduled jobs. The plugin is based on the [quartz project](http://quartz-scheduler.org/).
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Plugins
|
||||
---
|
||||
title: Overview
|
||||
---
|
||||
|
||||
### Authentication
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# SCM-Server SSL
|
||||
---
|
||||
title: SCM-Server SSL
|
||||
---
|
||||
|
||||
**Note**: This document describes a ssl configuration with a
|
||||
self-signed certificate
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Screenshots
|
||||
---
|
||||
title: Screenshots
|
||||
displayToc: true
|
||||
---
|
||||
|
||||
<http://www.scm-manager.org/screenshots/>
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Snippet: Authentication
|
||||
---
|
||||
title: Snippet - Authentication
|
||||
---
|
||||
|
||||
```java
|
||||
package sonia.scm.snippets;
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Snippet: Extend global configuration
|
||||
---
|
||||
title: Snippet - Extend global configuration
|
||||
---
|
||||
|
||||
```javascript
|
||||
// register the new configuration form
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
### Snippet: Extend Navigation
|
||||
---
|
||||
title: Snippet - Extend Navigation
|
||||
---
|
||||
|
||||
```javascript
|
||||
// add login callback
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Snippet: Add tab to repository configuration
|
||||
---
|
||||
title: Snippet - Add tab to repository configuration
|
||||
---
|
||||
|
||||
```javascript
|
||||
/**
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Mercurial Subrepositories
|
||||
---
|
||||
title: Mercurial Subrepositories
|
||||
---
|
||||
|
||||
In the following examples i will use the [scm-cli-client](command-line-client.md)
|
||||
to create the repositories, but you can also use the web interface to
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Trac Plugin
|
||||
---
|
||||
title: Trac Plugin
|
||||
---
|
||||
|
||||
The plugin enables the following features to integrate SCM-Manager to [Trac](http://trac.edgewall.org/):
|
||||
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Upgrade to a new Version
|
||||
---
|
||||
title: Upgrade to a new Version
|
||||
---
|
||||
|
||||
If you would like to update SCM-Manager, you have to do the following
|
||||
steps.
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# WebHook Plugin
|
||||
---
|
||||
title: Webhook Plugin
|
||||
---
|
||||
|
||||
### Installation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user