Skip to content
This repository was archived by the owner on Nov 9, 2022. It is now read-only.

Commit ccd9fbc

Browse files
committed
Created feature-21 branch - Alerting support
1 parent f45a2fe commit ccd9fbc

File tree

3 files changed

+50
-9
lines changed

3 files changed

+50
-9
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ your vision does not align with that of a project maintainer.
7373
#### Create a branch for your feature
7474

7575
Okay, so you have decided to add something. Create an issue on GitHub if you haven't already, as you'll need the ID.
76-
Now create a feature branch and start hacking:
76+
Now create a feature branch and start hacking. You can do this on your own fork, or the main site if a 'Contributor':
7777

7878
```sh
7979
$ git checkout -b feature-ISSUEID develop
@@ -93,7 +93,8 @@ To share the branch so others can see it (although advised not to work on it) do
9393
$ git push --set-upstream origin feature-ISSUEID
9494
```
9595

96-
Now your feature branch [will be visible on GitHub](https://github.com/adamfowleruk/marklogicworkflow/branches).
96+
Now your feature branch [will be visible on GitHub](https://github.com/adamfowleruk/marklogicworkflow/branches) if you
97+
are a contributor.
9798

9899
#### Formatting code
99100

@@ -119,16 +120,23 @@ Make sure that all tests pass. Please, do not submit patches that fail.
119120

120121
When the feature is complete and ready to be integrated back in to the develop branch:-
121122

123+
1. If on your own Fork (99% of people):-
122124
```sh
123125
$ git commit -m "Fixes #ISSUEID"
124126
$ git pull origin develop
125127
$ git checkout develop
126128
$ git merge feature-ISSUEID
127129
$ git push
128-
$ git branch -d feature-ISSUEID
129130
```
130131

131-
Only do the last command if the others complete successfully. You may have to merge conflicts.
132+
2. If an assigned admin user (contributor) on the main project, do this instead:-
133+
```sh
134+
$ git commit -m "Fixes #ISSUEID"
135+
$ git push
136+
```
137+
138+
Now issue a pull request for your changes to the main project.
139+
132140

133141
You're now done! Adding the 'Fixes #ISSUEID' comment to the last commit automatically closes the issue with a reference
134142
to your code.

documentation/DEV-MODELER.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,39 @@ you access to everything you need.
2626
Until this happens, or if you need the very latest MarkLogic Workflow model element support whilst working on a new
2727
project, you will need to execute the extension manually.
2828

29-
To execute the latest extension:-
30-
- Checkout or download the zip of the latest (develop branch) of MarkLogic Workflow at http://github.com/adamfowleruk/marklogicworkflow
29+
### Latest from source (any branch) for Plugin development
30+
31+
Note: If following the Contributing guide, you should have logged an issue and created a new branch from develop using
32+
```sh
33+
$ git checkout -b feature-ISSUEID develop
34+
```
35+
36+
To execute the latest extension from source:-
37+
- Checkout or download the zip of the latest (develop or feature branch) of MarkLogic Workflow at http://github.com/adamfowleruk/marklogicworkflow
3138
- Open Eclipse Luna (4.4) or above
3239
- Go to File -> Import project
3340
- Navigate to ./marklogicworkflow/eclipse/org.eclipse.bpmn2.modeler.runtime.marklogic (NOT just ./marklogicworkflow)
3441
- Import this workspace
3542
- Double click on the 'plugin.xml' file
3643
- In the top right of the edit dialogue for this file, click the green Play button. This launches Eclipse Luna with this extension
44+
45+
### Current published In Development version
46+
47+
- In Eclipse Luna (4.4) or above, go to Help -> Install new software
48+
- In the update site field type https://raw.githubusercontent.com/adamfowleruk/marklogicworkflow/develop/eclipse/MarkLogicWorkflowUpdateSite
49+
- It will take a few seconds to download plugin information
50+
- Select the Eclipse BPMN2 Modeler - MarkLogic Workflow Runtime Extension Feature
51+
- Click Next
52+
- Follow the prompts
53+
- NOTE: If you are warned about the project not being signed, click on 'OK' and NOT 'Cancel' to proceed with installation
54+
- Restart Eclipse Luna
55+
56+
### Current published released version
57+
58+
- As for Current published in development version, except use this URL: https://raw.githubusercontent.com/adamfowleruk/marklogicworkflow/master/eclipse/MarkLogicWorkflowUpdateSite
59+
60+
## Creating a new Workflow process diagram
61+
3762
- Now go to File - Import or File - New Project to create your new modelling project
3863
- Right click the root folder and select New - Other
3964
- Open the 'BPMN2' category and select either 'MarkLogic CPF Process Diagram' or 'MarkLogic Workflow Process Diagram'
@@ -52,10 +77,16 @@ In the future MarkLogic Workflow will allow any arbitrary CPF pipeline to be exp
5277
modeler. This will allow for full round trip re-engineering of MarkLogic CPF processes.
5378

5479
*WARNING: It should be noted that CPF diagram support is very much an Alpha product and not scheduled to be fully
55-
implemented for a while.*
80+
implemented for a while.*
5681

5782
## Related information
5883

59-
For the custom runtime/task videos, see this first:-
84+
The best source for Eclipse extension tutorials is:-
85+
https://wiki.eclipse.org/BPMN2-Modeler/DeveloperTutorials
86+
87+
These have been updated for the latest Luna version of the Eclipse BPMN2 modeler
88+
89+
You may also find it instructive to download the 'jBPM Runtime Extension' project from the above project's GitHub site.
90+
I use this for many examples.
6091

61-
http://bobsbizbuzz.blogspot.it/2014/06/blog-post_10.html
92+
A developer forum is also available: https://www.eclipse.org/forums/index.php/f/226/

documentation/MODELLING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The Eclipse BPMN2 modeller is a good option, with support for pluggable runtime
1616
easy to define a MarkLogic runtime and set of custom tasks, and hide any BPMN2 tasks that we do not support the
1717
execution of.
1818

19+
To install the MarkLogic Workflow BPMN2 Eclipse modeler extension, see the [Modelling Development page](DEV-MODELER.md).
20+
1921
Also view the [BPMN2 specification summary document](bpmn2-spec.md)
2022

2123
Also take a look at the [Step documentation](STEPS.md) for information on individual steps and supported parameters.

0 commit comments

Comments
 (0)