mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-01-04 22:59:51 +01:00
Move mockup resources and rename v2 doc files for more consistency
This commit is contained in:
31
docs/Home.md
31
docs/Home.md
@@ -83,21 +83,22 @@ repositories over http.
|
||||
### SCM Manager 2
|
||||
|
||||
- [Configuration for Intellij IDEA](v2/intellij-idea-configuration.md)
|
||||
- [State of SCM-Manager 2 development](v2/State%20of%20SCM-Manager%202%20development.md)
|
||||
- [SCM v2 Test Cases](v2/SCMM-v2-Test-Cases.md)
|
||||
- [Table of decisions made during development](v2/Decision-Table.md)
|
||||
- [Definition of done](Definition%20of%20done.md)
|
||||
- [State of SCM-Manager 2 development](v2/state-of-development.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%20a%20new%20Plugin.md)
|
||||
- [Migrate Plugin from v1](v2/Migrate%20Plugin%20from%20v1.md)
|
||||
- [Plugin Development](v2/Plugin%20Development.md)
|
||||
- [i18n for Plugins](v2/i18n%20for%20Plugins.md)
|
||||
- [Extension Points](v2/Extension-Points.md)
|
||||
- [API changes](v2/API%20changes.md)
|
||||
- [ui-components/ui-types](v2/UI%20Additions%20or%20Changes%20to%20ui-components%20or%20ui-types.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)
|
||||
- [Changes to ui-components/ui-types](v2/changes-to-ui-components-or-ui-types.md)
|
||||
- [Permission concept](v2/permission-concept.md)
|
||||
- [Vulnerabilities](v2/vulnerabilities.md)
|
||||
- [Common pitfall](v2/Common%20pitfall.md)
|
||||
- [Release process](v2/Release%20process.md)
|
||||
- [Migration Wizard](v2/Migration-Wizard.md)
|
||||
- [Known Issues](v2/Known%20Issues.md)
|
||||
- [Common pitfall](v2/common-pitfall.md)
|
||||
- [Release process](v2/release-process.md)
|
||||
- [Known Issues](v2/known-issues.md)
|
||||
|
||||
|
Before Width: | Height: | Size: 217 KiB After Width: | Height: | Size: 217 KiB |
|
Before Width: | Height: | Size: 338 KiB After Width: | Height: | Size: 338 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
@@ -1,20 +1,19 @@
|
||||
# Migrate an v1 plugin
|
||||
|
||||
Before starting, make sure to read the [Plugin Development](Plugin%20Development.md)
|
||||
Before starting, make sure to read the [Plugin Development](plugin-development.md)
|
||||
|
||||
**NOTE**: until there is no release the current version of scm-manager has to be cloned and build on the machine
|
||||
of the plugin developer.
|
||||
|
||||
```bash
|
||||
hg clone https://bitnucket.org/sdorra/scm-manager
|
||||
git clone git@github.com:scm-manager/scm-manager.git
|
||||
cd scm-manager
|
||||
hg update 2.0.0-m3
|
||||
./mvnw clean install
|
||||
```
|
||||
|
||||
To migrate an existing SCM-Manager 1.x Plugin, you have to do the following steps:
|
||||
|
||||
### Maven (pom.xml):
|
||||
### Maven (pom.xml)
|
||||
|
||||
* create a separate branch for the new version
|
||||
* It might be helpful to start and review the old version of the plugin via `mvn scmp:run` for later reference.
|
||||
@@ -80,7 +79,7 @@ diff -r a988f4cfb7ab pom.xml
|
||||
<repository>
|
||||
```
|
||||
|
||||
### Plugin Descriptor (src/main/resources/META-INF/scm/plugin.xml):
|
||||
### Plugin Descriptor (src/main/resources/META-INF/scm/plugin.xml)
|
||||
|
||||
* add the following dtd to the top of the plugin.xml: `<!DOCTYPE plugin SYSTEM "https://download.scm-manager.org/dtd/plugin/2.0.0-01.dtd">`
|
||||
* add an scm-version element with the value 2 to the plugin.xml
|
||||
@@ -123,7 +122,7 @@ diff -r a988f4cfb7ab src/main/resources/META-INF/scm/plugin.xml
|
||||
### Java sources (src/main/java)
|
||||
|
||||
* try to compile the sources: `mvn compile`
|
||||
* fix problems (See [API changes](API%20changes.md))
|
||||
* fix problems (See [API changes](api-changes.md))
|
||||
* Remove XML accept headers from REST Resource classes -> SCMMv2 supports JSON only
|
||||
* Migrate REST Resources (e.g. `v2`, add to Index Resource, Update Links) - See core plugins Git, Hg, Svn, e.g. [`GitConfigResource`](https://bitbucket.org/sdorra/scm-manager/src/3d5a24c177f33c14a7c08f19e124be03b1a877ba/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/api/v2/resources/GitConfigResource.java)
|
||||
|
||||
@@ -162,7 +161,7 @@ Some more hints:
|
||||
|
||||
* For Configuration UIs use [`ConfigurationBinder`](https://bitbucket.org/sdorra/scm-manager/src/c888128358712ab1f5f34ff593e1cf6854b06c08/scm-ui-components/packages/ui-components/src/config/ConfigurationBinder.js) - See core plugins Git, Hg, Svn, e.g. [scm-git-plugin/index.js](https://bitbucket.org/sdorra/scm-manager/src/6d64a380a37db63c95eccbfbf18e4500c9224d32/scm-plugins/scm-git-plugin/src/main/js/index.js).
|
||||
Note that `readOnly` property checks if update link is returned by REST resource
|
||||
* Don't forget [i18n for Plugins](i18n%20for%20Plugins.md)
|
||||
* Don't forget [i18n for Plugins](i18n-for-plugins.md)
|
||||
* If you need to add extension points to core SCMM, you can link your local development instance into smp-maven-plugin, see [scm-review-plugin/pom.xml](https://github.com/scm-manager/scm-review-plugin/commit/0ea74634830ef4865afacf714de009302e26353d#diff-600376dffeb79835ede4a0b285078036R72)
|
||||
|
||||
# Further reading
|
||||
@@ -18,7 +18,11 @@ To specify the new names (and namespaces), the SCM-Manager version 2 starts a mi
|
||||
2019-12-05 14:01:35.110 [main] [ ] INFO sonia.scm.update.MigrationWizardModule - ==========================================================
|
||||
```
|
||||
|
||||
You can open this wizard in an internet browser using the URL of your installation (eg. http://localhost:8080/scm/). 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:
|
||||
You can open this wizard in an internet browser using the URL of your installation (eg. http://localhost:8080/scm/).
|
||||
|
||||

|
||||
|
||||
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:
|
||||
|
||||
|Strategy|Action|
|
||||
|---|---|
|
||||
@@ -119,11 +119,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:
|
||||
|
||||

|
||||

|
||||
|
||||
The layout of the permission component UI could look like this:
|
||||
|
||||

|
||||

|
||||
|
||||
The UI
|
||||
* queries all available global permissions from the REST API (shiro strings),
|
||||
@@ -139,7 +139,7 @@ permissions (see `PermissionType`).
|
||||
|
||||
The UI is extended like so:
|
||||
|
||||

|
||||

|
||||
|
||||
#### Existing repository dialog
|
||||
|
||||
@@ -395,7 +395,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%20for%20Plugins.md)
|
||||
* All permission i18n are described in `plugins.json` (also for core), see [i18n for Plugins](i18n-for-plugins.md)
|
||||
* That way the UI for users and groups can find all the translation in the same file
|
||||
* Convention for i18n keys: `permissions.<shiro-String>`, containing `displayName` and `description` each.
|
||||
|
||||
@@ -42,7 +42,7 @@ the SCM-Manager context will restart automatically. So you can see your changes
|
||||
* .eslintrc (ui linter configuration)
|
||||
* .flowconfig (ui typecheck configuration)
|
||||
* .babelrc (ui javascript language level configuration)
|
||||
* src/main/resource/locale/(de|en)/plugins.json (i18n configuration, see [i18n for plugins](i18n%20for%20Plugins.md))
|
||||
* src/main/resource/locale/(de|en)/plugins.json (i18n configuration, see [i18n for plugins](i18n-for-plugins.md))
|
||||
* META-INF/scm/plugin.xml (plugin descriptor)
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# 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)
|
||||
@@ -10,4 +10,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](extension-points.md) |
|
||||
Reference in New Issue
Block a user