From daeb8b7cbb65532c7eb09133f279374a0ee5c3f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= Date: Wed, 6 May 2020 15:41:14 +0200 Subject: [PATCH] Remove v2 sub folder and add Front Matter --- docs/en/Home.md | 105 ------------------ docs/en/State of SCM-Manager 2 development.md | 4 +- docs/en/apache/apache-mod_jk.md | 4 +- docs/en/apache/apache-mod_proxy.md | 4 +- docs/en/{v2 => }/basedirectory.md | 4 +- docs/en/build-from-source.md | 26 ++--- docs/en/command-line-client.md | 4 +- docs/en/{v2 => }/common-pitfall.md | 4 +- docs/en/{v2 => }/create-plugin.md | 4 +- docs/en/{v2 => }/decision-table.md | 4 +- docs/en/definition-of-done.md | 4 +- docs/en/{v2 => }/error-handling.md | 4 +- docs/en/{v2 => }/extension-points.md | 4 +- docs/en/faq.md | 4 +- docs/en/getting-started.md | 24 +++- docs/en/{v2 => }/i18n-for-plugins.md | 4 +- docs/en/index.md | 67 +++++++++++ .../{v2 => }/intellij-idea-configuration.md | 4 +- docs/en/{v2 => }/known-issues.md | 4 +- docs/en/{v2 => }/logging.md | 4 +- docs/en/mercurial/clone-empty.md | 4 +- docs/en/mercurial/push-bookmark.md | 4 +- .../push-multiple-branches-to-new.md | 4 +- docs/en/mercurial/push-multiple-branches.md | 4 +- docs/en/mercurial/push-single-changeset.md | 4 +- docs/en/{v2 => }/migrate-plugin-from-v1.md | 8 +- docs/en/{v2 => }/migration-wizard.md | 6 +- docs/en/nginx.md | 4 +- docs/en/{v2 => }/permission-concept.md | 12 +- docs/en/plugin-descriptor.md | 4 +- docs/en/{v2 => }/plugin-development.md | 4 +- docs/en/{v2 => }/release-process.md | 4 +- docs/en/rv-plugin-comparison.md | 4 +- docs/en/scm-server-ssl.md | 4 +- docs/en/{v2 => }/state-of-development.md | 4 +- docs/en/{v2 => }/style-guide.md | 6 +- docs/en/{v2 => }/test-cases.md | 4 +- docs/en/{v2 => }/ui-dod.md | 6 +- docs/en/v2/api-changes.md | 3 - docs/en/v2/getting-started.md | 47 -------- docs/en/{v2 => }/vulnerabilities.md | 6 +- 41 files changed, 212 insertions(+), 220 deletions(-) delete mode 100644 docs/en/Home.md rename docs/en/{v2 => }/basedirectory.md (97%) rename docs/en/{v2 => }/common-pitfall.md (96%) rename docs/en/{v2 => }/create-plugin.md (76%) rename docs/en/{v2 => }/decision-table.md (99%) rename docs/en/{v2 => }/error-handling.md (99%) rename docs/en/{v2 => }/extension-points.md (98%) rename docs/en/{v2 => }/i18n-for-plugins.md (98%) create mode 100644 docs/en/index.md rename docs/en/{v2 => }/intellij-idea-configuration.md (97%) rename docs/en/{v2 => }/known-issues.md (98%) rename docs/en/{v2 => }/logging.md (98%) rename docs/en/{v2 => }/migrate-plugin-from-v1.md (96%) rename docs/en/{v2 => }/migration-wizard.md (98%) rename docs/en/{v2 => }/permission-concept.md (98%) rename docs/en/{v2 => }/plugin-development.md (99%) rename docs/en/{v2 => }/release-process.md (98%) rename docs/en/{v2 => }/state-of-development.md (96%) rename docs/en/{v2 => }/style-guide.md (90%) rename docs/en/{v2 => }/test-cases.md (99%) rename docs/en/{v2 => }/ui-dod.md (81%) delete mode 100644 docs/en/v2/api-changes.md delete mode 100644 docs/en/v2/getting-started.md rename docs/en/{v2 => }/vulnerabilities.md (82%) diff --git a/docs/en/Home.md b/docs/en/Home.md deleted file mode 100644 index c5a6293fd9..0000000000 --- a/docs/en/Home.md +++ /dev/null @@ -1,105 +0,0 @@ -The easiest way to share and manage your Git, Mercurial and Subversion -repositories over http. - -- Very easy installation -- No need to hack configuration files, SCM-Manager is completely - configureable from its Web-Interface -- No Apache and no database installation is required -- Central user, group and permission management -- Out of the box support for Git, Mercurial and Subversion -- Full RESTFul Web Service API (JSON and XML) -- Rich User Interface -- Simple Plugin API -- Useful plugins available ( f.e. Ldap-, ActiveDirectory-, - PAM-Authentication) -- Licensed under the MIT-License - -### News - -- **2018-09-25** - [SCM-Manager 2 gets a boost by Cloudogu GmbH](https://www.scm-manager.org/scm-manager-2/scm-manager-2-gets-a-boost-by-cloudogu-gmbh/) -- **2018-05-04** - SCM-Manager 1.60 released ([download](http://www.scm-manager.org/download/) \| - [release notes](release-notes.md)) -- **2018-04-11** - SCM-Manager 1.59 released - -[All news](http://www.scm-manager.org/news/) - -### Mailing List - -- - - [archive](http://groups.google.com/group/scmmanager) \| - [subscribe](mailto:scmmanager+subscribe@googlegroups.com) - \| - [unsubscribe](mailto:scmmanager+unsubscribe@googlegroups.com) - -### Use SCM-Manager - -- [Getting started](getting-started.md) -- [Download latest version](http://www.scm-manager.org/download/) -- [Frequently Asked Questions](faq.md) -- [Upgrade SCM-Manager to a newer version](upgrade.md) -- [Download latest snapshot release](download-snapshot-release.md) -- [Download Archive](download-archive.md) -- [Command line client](command-line-client.md) -- [SCM-Server SSL](scm-server-ssl.md) -- [ApplicationServer (Tomcat/Glassfish/Jetty)](applicationserver.md) -- [Using SCM-Manager with Apache mod\_proxy](apache/apache-mod_proxy.md) -- [Using SCM-Manager with Nginx](nginx.md) -- [Using SCM-Manager with IIS (Helicon)](iis-helicon.md) -- [Permissions](Permissions.md) -- [Plugins](http://plugins.scm-manager.org/scm-plugin-backend/page/index.html) -- [Revision Control Plugin Comparison](rv-plugin-comparison.md) -- [Screenshots](http://www.scm-manager.org/screenshots/) -- [Mercurial Subrepositories](subrepositories.md) -- [Unix Daemons and Windows Services](daemons.md) -- [RPM and DEB packages](RPM%20and%20DEB%20packages.md) -- [Build windows mercurial packages for SCM-Manager](https://bitbucket.org/sdorra/build-win-hg-packages) - -### Plugin documentation - -- [Active Directory Plugin](active-directory-plugin.md) -- [Branch Write Protect Plugin](branchwp-plugin.md) -- [Jenkins Plugin](jenkins-plugin.md) -- [Jira Plugin](jira-plugin.md) -- [Mail Plugin](mail-plugin.md) -- [Path Write Protect Plugin](pathwp-plugin.md) -- [Redmine Plugin](redmine-plugin.md) -- [Scheduler Plugin](scheduler-plugin.md) -- [Trac Plugin](trac-plugin.md) -- [WebHook Plugin](webhook-plugin.md) - -### Development - -- [Building SCM-Manager from source](build-from-source.md) -- [Java Client API](java-client-api.md) -- [Code Snippets](code-snippets.md) -- [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) -- [Injection Objects](injectionObjects.md) -- [API documentation](http://docs.scm-manager.org/apidocs/latest/) -- [WebService documentation](http://docs.scm-manager.org/restdocs/current/) - -### SCM Manager 2 - -- [Getting started](v2/getting-started.md) -- [Base directory](v2/basedirectory.md) -- [Logging](v2/logging.md) -- [Configuration for Intellij IDEA](v2/intellij-idea-configuration.md) -- [SCM v2 Test Cases](v2/test-cases.md) -- [Table of decisions made during development](v2/decision-table.md) -- [Definition of done](definition-of-done.md) -- [Style Guide](v2/style-guide.md) -- [Error Handling in REST, Java, UI](v2/error-handling.md) -- [Create a new Plugin](v2/create-plugin.md) -- [Migration Wizard](v2/migration-wizard.md) -- [Plugin Development](v2/plugin-development.md) -- [i18n for Plugins](v2/i18n-for-plugins.md) -- [Extension Points](v2/extension-points.md) -- [Migrate Plugin from v1](v2/migrate-plugin-from-v1.md) -- [API changes](v2/api-changes.md) -- [Permission concept](v2/permission-concept.md) -- [Vulnerabilities](v2/vulnerabilities.md) -- [Common pitfall](v2/common-pitfall.md) -- [Release process](v2/release-process.md) -- [Known Issues](v2/known-issues.md) diff --git a/docs/en/State of SCM-Manager 2 development.md b/docs/en/State of SCM-Manager 2 development.md index b7d2429584..38823de474 100644 --- a/docs/en/State of SCM-Manager 2 development.md +++ b/docs/en/State of SCM-Manager 2 development.md @@ -1,4 +1,6 @@ -# State of SCM-Manager 2 development +--- +title: 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) diff --git a/docs/en/apache/apache-mod_jk.md b/docs/en/apache/apache-mod_jk.md index 5604dd118e..fcc1fb5145 100644 --- a/docs/en/apache/apache-mod_jk.md +++ b/docs/en/apache/apache-mod_jk.md @@ -1,4 +1,6 @@ -# SCM-Server and Apache mod\_jk +--- +title: SCM-Server and Apache mod\_jk +--- ### Apache Configuration ```apache diff --git a/docs/en/apache/apache-mod_proxy.md b/docs/en/apache/apache-mod_proxy.md index 16e8eaf14d..a54075f84f 100644 --- a/docs/en/apache/apache-mod_proxy.md +++ b/docs/en/apache/apache-mod_proxy.md @@ -1,4 +1,6 @@ -# SCM-Server and Apache mod\_proxy +--- +title: SCM-Server and Apache mod\_proxy +--- ### Apache configuration diff --git a/docs/en/v2/basedirectory.md b/docs/en/basedirectory.md similarity index 97% rename from docs/en/v2/basedirectory.md rename to docs/en/basedirectory.md index 88408fa07b..13d67903f3 100644 --- a/docs/en/v2/basedirectory.md +++ b/docs/en/basedirectory.md @@ -1,4 +1,6 @@ -# Base Directory +--- +title: Base Directory +--- The SCM-Manager base directory aka. home directory, contains all data which is created by SCM-Manager such as repositories and configurations. diff --git a/docs/en/build-from-source.md b/docs/en/build-from-source.md index 4ad9fa7fdd..dd770f0323 100644 --- a/docs/en/build-from-source.md +++ b/docs/en/build-from-source.md @@ -1,18 +1,20 @@ -# Building SCM-Manager from source +--- +title: Building SCM-Manager from source +--- ### Software Requirements -- JDK 1.7 or higher - ([download](http://www.oracle.com/technetwork/java/index.html)) +- JDK 1.8 or higher + ([download](https://openjdk.java.net/install/)) - Maven 3 or higher ([download](http://maven.apache.org/)) - Mercurial ([download](https://www.mercurial-scm.org/)) -### Build SCM-Manager 1.x from source +### Build SCM-Manager 2.x from source ```bash -hg clone https://bitbucket.org/sdorra/scm-manager +hg clone https://github.com/scm-manager/scm-manager.git cd scm-manager -hg update 1.x +git checkout develop mvn clean install ``` @@ -26,15 +28,3 @@ located at **scm-server/target/scm-server-app**. You can also start a dev server using `mvn jetty:run-war -f scm-webapp`. SCM-Manager is served at . - -### REST - -Docs: - -- Create the documentation: `mvn -f scm-webapp compile -P doc` -- The documentation can be found at scm-webapp/target/restdocs - -Note that if using jetty (see above) you have to access - once, to trigger creation of the -`scmadmin` user. Then you can access the REST api directly - diff --git a/docs/en/command-line-client.md b/docs/en/command-line-client.md index 352070bd17..86c4c29671 100644 --- a/docs/en/command-line-client.md +++ b/docs/en/command-line-client.md @@ -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). diff --git a/docs/en/v2/common-pitfall.md b/docs/en/common-pitfall.md similarity index 96% rename from docs/en/v2/common-pitfall.md rename to docs/en/common-pitfall.md index 4026a894dd..a226bdd4ed 100644 --- a/docs/en/v2/common-pitfall.md +++ b/docs/en/common-pitfall.md @@ -1,4 +1,6 @@ -# Common pitfall occurred while developing the SCM V2 +--- +title: Common pitfall occurred while developing the SCM V2 +--- ## React Component is loaded unexpectedly diff --git a/docs/en/v2/create-plugin.md b/docs/en/create-plugin.md similarity index 76% rename from docs/en/v2/create-plugin.md rename to docs/en/create-plugin.md index a825375ee5..cb86ba23a3 100644 --- a/docs/en/v2/create-plugin.md +++ b/docs/en/create-plugin.md @@ -1,4 +1,6 @@ -# Create a new plugin +--- +title: Create a new plugin +--- There is a service which is able to create a skeleton for a new plugin: diff --git a/docs/en/v2/decision-table.md b/docs/en/decision-table.md similarity index 99% rename from docs/en/v2/decision-table.md rename to docs/en/decision-table.md index c38d6cc5dc..b4e5c9ab12 100644 --- a/docs/en/v2/decision-table.md +++ b/docs/en/decision-table.md @@ -1,4 +1,6 @@ -# Decision Table +--- +title: Decision Table +--- ### Lombok diff --git a/docs/en/definition-of-done.md b/docs/en/definition-of-done.md index d5763df698..c37cd0a883 100644 --- a/docs/en/definition-of-done.md +++ b/docs/en/definition-of-done.md @@ -1,4 +1,6 @@ -# Definition of Done +--- +title: Definition of Done +--- * Acceptance criteria are checked manually (from the user's perspective) * Code coverage is checked manually (>= 80% on new code) ([sonarcloud](https://sonarcloud.io/dashboard?id=sonia.scm%3Ascm)) diff --git a/docs/en/v2/error-handling.md b/docs/en/error-handling.md similarity index 99% rename from docs/en/v2/error-handling.md rename to docs/en/error-handling.md index b249ca9f5f..518bd58fad 100644 --- a/docs/en/v2/error-handling.md +++ b/docs/en/error-handling.md @@ -1,4 +1,6 @@ -# Error Handling +--- +title: Error Handling +--- As a highly extensible product, SCM-Manager offers at least three ways to interact with: diff --git a/docs/en/v2/extension-points.md b/docs/en/extension-points.md similarity index 98% rename from docs/en/v2/extension-points.md rename to docs/en/extension-points.md index 519647cbd6..43492a2931 100644 --- a/docs/en/v2/extension-points.md +++ b/docs/en/extension-points.md @@ -1,4 +1,6 @@ -# Extension Points +--- +title: Extension Points +--- The following extension points are provided for the frontend: diff --git a/docs/en/faq.md b/docs/en/faq.md index 29aa799bff..5f07c61257 100644 --- a/docs/en/faq.md +++ b/docs/en/faq.md @@ -1,4 +1,6 @@ -# Frequently Asked Questions +--- +title: Frequently Asked Questions +--- ### What are the username and the password in the default installation? diff --git a/docs/en/getting-started.md b/docs/en/getting-started.md index 623070f5b9..fee8d29fcd 100644 --- a/docs/en/getting-started.md +++ b/docs/en/getting-started.md @@ -1,8 +1,10 @@ -# Getting started +--- +title: Getting started +--- ### Install Java -SCM-Manager needs an installed Java 1.7 or newer. It is recommended to use the [oracle jre](http://java.oracle.com/). +SCM-Manager needs an installed Java 1.8 or newer. It is recommended to use the [oracle jre](http://java.oracle.com/). How to check which version of Java is installed: ```bash @@ -13,6 +15,8 @@ Download java from [here](http://java.oracle.com/) and follow the install instru ### Install SCM-Manager +#### Standalone Server + Download the latest version of SCM-Manager from [here](http://www.scm-manager.org/download/), unpack the .zip or .tar.gz package and start SCM-Manager with @@ -21,8 +25,24 @@ or .tar.gz package and start SCM-Manager with scm-server/bin/scm-server ``` +or + +```bash +scm-server\bin\scm-server.bat +``` + +#### Docker + +To start SCM-Manager with a persistent volume on port 8080 run the following command: + +```bash +docker run -p 8080:8080 -v scm-home:/var/lib/scm --name scm scmmanager/scm-manager:2.0.0-rc6 +``` + ### First access +Your SCM-Manager should be running on port 8080. You can access it locally via . + | | | | ------------ | ----------------------- | | **URL** | | diff --git a/docs/en/v2/i18n-for-plugins.md b/docs/en/i18n-for-plugins.md similarity index 98% rename from docs/en/v2/i18n-for-plugins.md rename to docs/en/i18n-for-plugins.md index 12fc8fd28e..2387783a8d 100644 --- a/docs/en/v2/i18n-for-plugins.md +++ b/docs/en/i18n-for-plugins.md @@ -1,4 +1,6 @@ -# i18n for Plugins +--- +title: i18n for Plugins +--- How to internationalize your own plugin ### Create the plugins.json file diff --git a/docs/en/index.md b/docs/en/index.md new file mode 100644 index 0000000000..9e478b6a47 --- /dev/null +++ b/docs/en/index.md @@ -0,0 +1,67 @@ +The easiest way to share and manage your Git, Mercurial and Subversion +repositories over http. + +- Very easy installation +- No need to hack configuration files, SCM-Manager is completely + configureable from its Web-Interface +- No Apache and no database installation is required +- Central user, group and permission management +- Out of the box support for Git, Mercurial and Subversion +- Full RESTFul Web Service API (JSON and XML) +- Rich User Interface +- Simple Plugin API +- Useful plugins available ( f.e. Ldap-, ActiveDirectory-, + PAM-Authentication) +- Licensed under the MIT-License + +### News + +- **2018-09-25** - [SCM-Manager 2 gets a boost by Cloudogu GmbH](https://www.scm-manager.org/scm-manager-2/scm-manager-2-gets-a-boost-by-cloudogu-gmbh/) +- **2018-05-04** - SCM-Manager 1.60 released ([download](http://www.scm-manager.org/download/) \| + [release notes](release-notes.md)) +- **2018-04-11** - SCM-Manager 1.59 released + +[All news](http://www.scm-manager.org/news/) + +### Mailing List + +- - + [archive](http://groups.google.com/group/scmmanager) \| + [subscribe](mailto:scmmanager+subscribe@googlegroups.com) + \| + [unsubscribe](mailto:scmmanager+unsubscribe@googlegroups.com) + +### Use SCM-Manager + +- [Getting started](getting-started.md) +- [Download latest version](http://www.scm-manager.org/download/) +- [Frequently Asked Questions](faq.md) +- [Using SCM-Manager with Apache mod\_proxy](apache/apache-mod_proxy.md) +- [Using SCM-Manager with Nginx](nginx.md) + +### Development + +- [Building SCM-Manager from source](build-from-source.md) + +### SCM Manager 2 + +- [Base directory](basedirectory.md) +- [Logging](logging.md) +- [Configuration for Intellij IDEA](intellij-idea-configuration.md) +- [SCM v2 Test Cases](test-cases.md) +- [Table of decisions made during development](decision-table.md) +- [Definition of done](definition-of-done.md) +- [Style Guide](style-guide.md) +- [Error Handling in REST, Java, UI](error-handling.md) +- [Create a new Plugin](create-plugin.md) +- [Migration Wizard](migration-wizard.md) +- [Plugin Development](plugin-development.md) +- [i18n for Plugins](i18n-for-plugins.md) +- [Extension Points](extension-points.md) +- [Migrate Plugin from v1](migrate-plugin-from-v1.md) +- [API changes](v2/api-changes.md) +- [Permission concept](permission-concept.md) +- [Vulnerabilities](vulnerabilities.md) +- [Common pitfall](common-pitfall.md) +- [Release process](release-process.md) +- [Known Issues](known-issues.md) diff --git a/docs/en/v2/intellij-idea-configuration.md b/docs/en/intellij-idea-configuration.md similarity index 97% rename from docs/en/v2/intellij-idea-configuration.md rename to docs/en/intellij-idea-configuration.md index 8ee624ec5b..21fd7d8aee 100644 --- a/docs/en/v2/intellij-idea-configuration.md +++ b/docs/en/intellij-idea-configuration.md @@ -1,4 +1,6 @@ -# Intellij IDEA Configuration +--- +title: Intellij IDEA Configuration +--- ## Backend diff --git a/docs/en/v2/known-issues.md b/docs/en/known-issues.md similarity index 98% rename from docs/en/v2/known-issues.md rename to docs/en/known-issues.md index 7e09dd8ef5..d7fd0f4cec 100644 --- a/docs/en/v2/known-issues.md +++ b/docs/en/known-issues.md @@ -1,4 +1,6 @@ -# Known Issues +--- +title: Known Issues +--- ## Asnychronous PreReceiveRepositoryHooks do not work with subversion diff --git a/docs/en/v2/logging.md b/docs/en/logging.md similarity index 98% rename from docs/en/v2/logging.md rename to docs/en/logging.md index 0afa208e5c..ae64f7bf51 100644 --- a/docs/en/v2/logging.md +++ b/docs/en/logging.md @@ -1,4 +1,6 @@ -# Logging +--- +title: Logging +--- SCM-Manager logs information which can be useful, if the system does not behave as expected. The logging behavior depends on your operating system and installation. diff --git a/docs/en/mercurial/clone-empty.md b/docs/en/mercurial/clone-empty.md index 44a81de20c..ce1c2fae66 100644 --- a/docs/en/mercurial/clone-empty.md +++ b/docs/en/mercurial/clone-empty.md @@ -1,4 +1,6 @@ -# Clone empty repository +--- +title: Clone empty repository +--- ```http GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1. diff --git a/docs/en/mercurial/push-bookmark.md b/docs/en/mercurial/push-bookmark.md index 9ed591f9f4..bdb2c09aac 100644 --- a/docs/en/mercurial/push-bookmark.md +++ b/docs/en/mercurial/push-bookmark.md @@ -1,4 +1,6 @@ -# Push bookmark +--- +title: Push bookmark +--- ```http GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1. diff --git a/docs/en/mercurial/push-multiple-branches-to-new.md b/docs/en/mercurial/push-multiple-branches-to-new.md index 734c479fef..060cac73a6 100644 --- a/docs/en/mercurial/push-multiple-branches-to-new.md +++ b/docs/en/mercurial/push-multiple-branches-to-new.md @@ -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. diff --git a/docs/en/mercurial/push-multiple-branches.md b/docs/en/mercurial/push-multiple-branches.md index 5827cb0ceb..16b8a4b494 100644 --- a/docs/en/mercurial/push-multiple-branches.md +++ b/docs/en/mercurial/push-multiple-branches.md @@ -1,4 +1,6 @@ -# Push multiple branches +--- +title: Push multiple branches +--- ```http GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1. diff --git a/docs/en/mercurial/push-single-changeset.md b/docs/en/mercurial/push-single-changeset.md index 499b4c21c3..d7ad480bcd 100644 --- a/docs/en/mercurial/push-single-changeset.md +++ b/docs/en/mercurial/push-single-changeset.md @@ -1,4 +1,6 @@ -# Push single changeset +--- +title: Push single changeset +--- ```http GET /scm/hg/hgtest?cmd=capabilities HTTP/1.1. diff --git a/docs/en/v2/migrate-plugin-from-v1.md b/docs/en/migrate-plugin-from-v1.md similarity index 96% rename from docs/en/v2/migrate-plugin-from-v1.md rename to docs/en/migrate-plugin-from-v1.md index 54c3b7aa44..a2ebe54a4f 100644 --- a/docs/en/v2/migrate-plugin-from-v1.md +++ b/docs/en/migrate-plugin-from-v1.md @@ -1,6 +1,8 @@ -# Migrate an v1 plugin +--- +title: Migrate an v1 plugin +--- -Before starting, make sure to read the [Plugin Development](plugin-development.md). +Before starting, make sure to read the [Plugin Development](docs/en/plugin-development.mdpment.md). To migrate an existing SCM-Manager 1.x Plugin, you have to do the following steps: @@ -162,7 +164,7 @@ Some more hints: * For Configuration UIs use [`ConfigurationBinder`](https://github.com/scm-manager/scm-manager/blob/develop/scm-ui/ui-components/src/config/ConfigurationBinder.tsx) - See core plugins Git, Hg, Svn, e.g. [scm-git-plugin/index.ts](https://github.com/scm-manager/scm-manager/blob/develop/scm-plugins/scm-git-plugin/src/main/js/index.ts). Note that `readOnly` property checks if update link is returned by REST resource - * Don't forget [i18n for Plugins](i18n-for-plugins.md) + * Don't forget [i18n for Plugins](docs/en/i18n-for-plugins.mdugins.md) # Further reading diff --git a/docs/en/v2/migration-wizard.md b/docs/en/migration-wizard.md similarity index 98% rename from docs/en/v2/migration-wizard.md rename to docs/en/migration-wizard.md index 199f6d0bcb..7a471d4a97 100644 --- a/docs/en/v2/migration-wizard.md +++ b/docs/en/migration-wizard.md @@ -1,4 +1,6 @@ -# Migration-Wizard +--- +title: Migration-Wizard +--- To upgrade an SCM-Manager from version 1 to version 2, some changes have to be made according the home directory of the SCM-Manager. So before you start, **make sure that you have an up to date backup of your SCM home folder!** @@ -20,7 +22,7 @@ To specify the new names (and namespaces), the SCM-Manager version 2 starts a mi You can open this wizard in an internet browser using the URL of your installation (eg. http://localhost:8080/scm/). -![Migration Wizard](../screenshots/migration-wizard.png) +![Migration Wizard](docs/en/screenshots/migration-wizard.png) In the figure you can see an example of the page. We tried to guess meaningful names, but for sure you want to make some changes here. Beside choosing new namespaces and names you have to select a migration strategy for each repository. The strategies are described on the page as follows: diff --git a/docs/en/nginx.md b/docs/en/nginx.md index 5b14695c40..b4f68714a0 100644 --- a/docs/en/nginx.md +++ b/docs/en/nginx.md @@ -1,4 +1,6 @@ -# SCM-Server and Nginx +--- +title: SCM-Server and Nginx +--- ## Nginx configuration diff --git a/docs/en/v2/permission-concept.md b/docs/en/permission-concept.md similarity index 98% rename from docs/en/v2/permission-concept.md rename to docs/en/permission-concept.md index 0ce1ec00e2..cf19bb2fa2 100644 --- a/docs/en/v2/permission-concept.md +++ b/docs/en/permission-concept.md @@ -1,4 +1,6 @@ -# Permission Concept +--- +title: Permission Concept +--- This documents describes a concept for a fine-grained permission managing via the SCMMv2 UI. @@ -119,11 +121,11 @@ In order to fulfill the requirements, this concept describes The global permission component can be reached from **either user and groups** components navigations. The following mockup shows this in the user component: -![Permissions mockup user](../resources/permissions-mockup-user.jpg) +![Permissions mockup user](docs/en/resources/permissions-mockup-user.jpg) The layout of the permission component UI could look like this: -![Permissions mockup global permissions](../resources/permissions-mockup-global-permissions.jpg) +![Permissions mockup global permissions](docs/en/resources/permissions-mockup-global-permissions.jpg) The UI * queries all available global permissions from the REST API (shiro strings), @@ -139,7 +141,7 @@ permissions (see `PermissionType`). The UI is extended like so: -![Permissions mockup repository permissions](../resources/permissions-mockup-repository-permissions.jpg) +![Permissions mockup repository permissions](docs/en/resources/permissions-mockup-repository-permissions.jpg) #### Existing repository dialog @@ -395,7 +397,7 @@ and write. That is, Internationalization can be handled using the following conventions: -* All permission i18n are described in `plugins.json` (also for core), see [i18n for Plugins](i18n-for-plugins.md) +* All permission i18n are described in `plugins.json` (also for core), see [i18n for Plugins](docs/en/i18n-for-plugins.mdugins.md) * That way the UI for users and groups can find all the translation in the same file * Convention for i18n keys: `permissions.`, containing `displayName` and `description` each. diff --git a/docs/en/plugin-descriptor.md b/docs/en/plugin-descriptor.md index 53631fa739..8f1a1d26f0 100644 --- a/docs/en/plugin-descriptor.md +++ b/docs/en/plugin-descriptor.md @@ -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 diff --git a/docs/en/v2/plugin-development.md b/docs/en/plugin-development.md similarity index 99% rename from docs/en/v2/plugin-development.md rename to docs/en/plugin-development.md index 3af76e710f..71aef89591 100644 --- a/docs/en/v2/plugin-development.md +++ b/docs/en/plugin-development.md @@ -1,4 +1,6 @@ -# SCM-Manager v2 Plugin Development +--- +title: SCM-Manager v2 Plugin Development +--- ## Build and testing diff --git a/docs/en/v2/release-process.md b/docs/en/release-process.md similarity index 98% rename from docs/en/v2/release-process.md rename to docs/en/release-process.md index d30b0d6289..78f2f9c85b 100644 --- a/docs/en/v2/release-process.md +++ b/docs/en/release-process.md @@ -1,4 +1,6 @@ -# How to release SCM-Manager v2 core +--- +title: How to release SCM-Manager v2 core +--- To release a new version of SCM-Manager v2 you have to do the following steps (replace placeholders `` accordingly, eg. with `2.1.0`): diff --git a/docs/en/rv-plugin-comparison.md b/docs/en/rv-plugin-comparison.md index c81899961d..a0b954b33c 100644 --- a/docs/en/rv-plugin-comparison.md +++ b/docs/en/rv-plugin-comparison.md @@ -1,4 +1,6 @@ -# Revision Control Plugin Comparison +--- +title: Revision Control Plugin Comparison +--- | Plugin Name | Name | Core-Plugin | Requirements | Url | | --- | --- | --- | --- | --- | diff --git a/docs/en/scm-server-ssl.md b/docs/en/scm-server-ssl.md index 4f91468cc8..55444d2379 100644 --- a/docs/en/scm-server-ssl.md +++ b/docs/en/scm-server-ssl.md @@ -1,4 +1,6 @@ -# SCM-Server SSL +--- +title: SCM-Server SSL +--- **Note**: This document describes a ssl configuration with a self-signed certificate diff --git a/docs/en/v2/state-of-development.md b/docs/en/state-of-development.md similarity index 96% rename from docs/en/v2/state-of-development.md rename to docs/en/state-of-development.md index 57892a4d01..ad448a7423 100644 --- a/docs/en/v2/state-of-development.md +++ b/docs/en/state-of-development.md @@ -1,4 +1,6 @@ -# State of SCM-Manager 2 development +--- +title: State of SCM-Manager 2 development +--- The development of SCM-Manager 2.0.0 is organised in [Trello Boards](https://trello.com/scmmanager). diff --git a/docs/en/v2/style-guide.md b/docs/en/style-guide.md similarity index 90% rename from docs/en/v2/style-guide.md rename to docs/en/style-guide.md index 41387ae712..9e6f6c4237 100644 --- a/docs/en/v2/style-guide.md +++ b/docs/en/style-guide.md @@ -1,4 +1,6 @@ -# Style Guide +--- +title: Style Guide +--- Starting with version 2 of SCM-Manager we have decided to change the code style and conform to more common rules. Furthermore we abandon the rule, that everything needs to have a javadoc description. Nonetheless we have decided against a "big bang" adaption of the new rule, because this would have lead to enourmous problems for merges from 1.x to 2.x. @@ -8,7 +10,7 @@ Also it is a good guide line to adapt Postel's law: *Be conservative in what you ## Java -Please mind the [EditorConfig](https://editorconfig.org/) file `.editorconfig` in the root of the SCM-Manager and the [configuration guide](intellij-idea-configuration.md) for IntelliJ IDEA. There are plugins for a lot of IDEs and text editors. +Please mind the [EditorConfig](https://editorconfig.org/) file `.editorconfig` in the root of the SCM-Manager and the [configuration guide](docs/en/intellij-idea-configuration.mdation.md) for IntelliJ IDEA. There are plugins for a lot of IDEs and text editors. - Indentation with 2 spaces and no tabs (we have kept this rule from 1.x) - Order of members: diff --git a/docs/en/v2/test-cases.md b/docs/en/test-cases.md similarity index 99% rename from docs/en/v2/test-cases.md rename to docs/en/test-cases.md index a3a91b5ca2..b434de2407 100644 --- a/docs/en/v2/test-cases.md +++ b/docs/en/test-cases.md @@ -1,4 +1,6 @@ -# SCM-Manager v2 Test Cases +--- +title: SCM-Manager v2 Test Cases +--- Describes the expected behaviour for SCMM v2 REST Resources using manual tests. diff --git a/docs/en/v2/ui-dod.md b/docs/en/ui-dod.md similarity index 81% rename from docs/en/v2/ui-dod.md rename to docs/en/ui-dod.md index 9b3c0d908b..0f569ba71b 100644 --- a/docs/en/v2/ui-dod.md +++ b/docs/en/ui-dod.md @@ -1,4 +1,6 @@ -# DOD for UI development +--- +title: DOD for UI development +--- Use this as a kind of a checklist whenever you develop something in the UI of SCM-Manager 2.x., regardless whether you are developing core features or plugins. @@ -10,4 +12,4 @@ Use this as a kind of a checklist whenever you develop something in the UI of SC | ☐ | add help icons to input components | | ☐ | not use colors directly, but refer to `is-primary` or `is-warning` | | ☐ | make sure your view works on mobile devices | -| ☐ | document [extension points in wiki](extension-points.md) | +| ☐ | document [extension points in wiki](docs/en/extension-points.mdoints.md) | diff --git a/docs/en/v2/api-changes.md b/docs/en/v2/api-changes.md deleted file mode 100644 index ed47915261..0000000000 --- a/docs/en/v2/api-changes.md +++ /dev/null @@ -1,3 +0,0 @@ -# API and concepts changes from SCM-Manger v1 to v2 - -*TODO:* document api and concept changes while we're migrating plugins diff --git a/docs/en/v2/getting-started.md b/docs/en/v2/getting-started.md deleted file mode 100644 index 34d3cea06b..0000000000 --- a/docs/en/v2/getting-started.md +++ /dev/null @@ -1,47 +0,0 @@ -# Getting started - -### Install Java - -SCM-Manager needs an installed Java 1.8 or newer. It is recommended to use the [oracle jre](http://java.oracle.com/). -How to check which version of Java is installed: - -```bash -java -version -``` - -Download java from [here](http://java.oracle.com/) and follow the install instructions. - -### Install SCM-Manager - -#### Standalone Server - -Download the latest version of SCM-Manager from -[Nexus](https://maven.scm-manager.org/nexus/#nexus-search;gav~sonia.scm~scm-server~2.*~~), -extract the downloaded .zip or .tar.gz archive and start SCM-Manager 2 with - -```bash -scm-server/bin/scm-server -``` - -or - -```bash -scm-server\bin\scm-server.bat -``` - -#### Docker - -To start SCM-Manager with a persistent volume on port 8080 run the following command: - -```bash -docker run -p 8080:8080 -v scm-home:/var/lib/scm --name scm scmmanager/scm-manager:2.0.0-rc6 -``` - -### First access - -Your SCM-Manager should be running on port 8080. You can access it locally via . - -| | | -| ------------ | ----------------------- | -| **Username** | scmadmin | -| **Password** | scmadmin | diff --git a/docs/en/v2/vulnerabilities.md b/docs/en/vulnerabilities.md similarity index 82% rename from docs/en/v2/vulnerabilities.md rename to docs/en/vulnerabilities.md index 28c6b06e1f..96a67fe951 100644 --- a/docs/en/v2/vulnerabilities.md +++ b/docs/en/vulnerabilities.md @@ -1,6 +1,8 @@ -# Vulnerabilities +--- +title: Vulnerabilities +--- ## Not applicable * **CVE-2014-0114**: BeanUtils is transitive dependency of Apache Shiro. It is only used to wire shiro components. -* **SONATYPE-2016-0026**: We disabled the "remember me" feature completly. \ No newline at end of file +* **SONATYPE-2016-0026**: We disabled the "remember me" feature completly.