Skip to content

Commit 74e06c7

Browse files
committed
Add contributing informations and links to blog and videos
Change-Id: I6491155e7d2a46743e8d97c13861f8cef1221f6b
1 parent a62bb4a commit 74e06c7

File tree

2 files changed

+71
-11
lines changed

2 files changed

+71
-11
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,21 @@ All it's dependencies are available in public maven repositories or in other sub
77
See [pentaho-gis-plugins/README.md](https://github.com/atolcd/pentaho-gis-plugins/tree/master/pentaho-gis-plugins/README.md) for building, installing or using.
88

99

10+
             [![Blog article](https://blog.atolcd.com/wp-content/uploads/sites/2/2015/06/pdi_gis_00.png)](https://blog.atolcd.com/une-extension-gis-dans-pentaho-data-integration-5/)
11+
12+
13+
Videos
14+
---------------------
15+
Provided steps presentation :
16+
17+
             [![Provided steps presentation](https://lh3.googleusercontent.com/proxy/xG_Nit5UEhPvdHnrMbYiLLJhbX0Di6qeDMDgBiDQt6mCblRvfbDi8UGQyvmzTi33Xdt0-oAPIa2hVxPUYVpf=w506-h285-n)](https://www.youtube.com/watch?v=gotnjNSVcaE)
18+
19+
Usage example :
20+
21+
             [![Usage example](https://lh3.googleusercontent.com/proxy/RwdveW5Zd1gPHjK0-imga_xMHp2Vgn7Roww1i1S7qlz0BA-do8CT8FLcIMg13kZ9vvurLmSZcRsH4OpXWaIq=w506-h285-n)](https://www.youtube.com/watch?v=IO0Chh0XjgY)
22+
23+
1024
Our company
1125
---------------------
12-
[Atol Conseils et Développements](http://www.atolcd.com)
26+
[Atol Conseils et Développements](http://www.atolcd.com)
1327
Follow us on twitter [@atolcd](https://twitter.com/atolcd)

pentaho-gis-plugins/README.md

+56-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Pentaho Data Integrator GIS Plugins
22
================================
33

4-
This project provides allows you to manage GIS data in Pentaho's Data Integration.
4+
This project allows you to manage GIS data in Pentaho's Data Integration.
55

6-
Works with:
6+
Works with PDI 5.4.
77

8-
- PDI 5.4
8+
             [![Blog article](https://blog.atolcd.com/wp-content/uploads/sites/2/2015/06/pdi_gis_00.png)](https://blog.atolcd.com/une-extension-gis-dans-pentaho-data-integration-5/)
99

1010

1111
Building the plugins
@@ -14,7 +14,9 @@ Check out the project if you have not already done so :
1414

1515
git clone git://github.com/atolcd/pentaho-gis-plugins.git
1616

17-
To package the plugins, run the following commands from the base project directory:
17+
Install Java, Maven and PDI 5.4.
18+
19+
To package the plugins, run the following commands from the base project directory :
1820

1921
# Install dependencies if needed
2022
mvn install
@@ -25,10 +27,26 @@ To package the plugins, run the following commands from the base project directo
2527
The built package is target/pentaho-gis-plugins-1.0-SNAPSHOT-bin.zip (version can differ)
2628

2729

30+
***Integration with Eclipse***
31+
32+
If you want to use the [Eclipse IDE](https://eclipse.org), you can easily create projects with maven. From the root directory of the project :
33+
34+
mvn eclipse:eclipse
35+
36+
Assume that the [M2Eclipse](http://www.eclipse.org/m2e) plugin is installed and import the project from Eclipse :
37+
38+
1. From the "Import" item of the "File" menu, select "Existing Projects into Workspace"
39+
2. Next, select the root directory of the project
40+
3. Eclipse suggests 7 projects : select them and Finish
41+
4. You can start working
42+
43+
It has been tested with Eclipse Luna and Mars.
44+
45+
2846
Installing/upgrading the module
2947
---------------------
3048

31-
***Method 1 : Pentaho's Marketplace installation*** (available soon)
49+
***Method 1 : Pentaho's Marketplace installation***
3250

3351
In PDI, open the *Marketplace* from the help menu. Select "PDI GIS Plugins" and click "Install this plugin".
3452
After the installation, you need to restart PDI.
@@ -39,10 +57,11 @@ Proceed in two steps : first use "Uninstall this plugin" then start a fresh inst
3957

4058
***Method 2 : Manual installation***
4159

42-
Install Java, Maven and PDI 5.4 and extract the content of pentaho-gis-plugins-VERSION-bin.zip in ${PENTAHO_HOME}/plugins/steps.
43-
Example of extraction from the root of the project :
60+
Extract the content of pentaho-gis-plugins-VERSION-bin.zip in ${PENTAHO_HOME}/plugins/steps.
61+
Example of extraction from the root directory of the project :
4462

45-
unzip target/pentaho-gis-plugins-1.0-SNAPSHOT-bin.zip -d ${PENTAHO_HOME}/plugins/steps
63+
wget https://github.com/atolcd/pentaho-gis-plugins/releases/download/v1.0-snapshot/pentaho-gis-plugins-1.0-SNAPSHOT-bin.zip
64+
unzip pentaho-gis-plugins-1.0-SNAPSHOT-bin.zip -d ${PENTAHO_HOME}/plugins/steps
4665

4766
To upgrade the plugin, delete files you added before and start a fresh installation.
4867

@@ -71,15 +90,42 @@ You will find new elements in "Geospatial"'s directory :
7190

7291
Some information is available [here](https://blog.atolcd.com/une-extension-gis-dans-pentaho-data-integration-5/) in french.
7392

93+
Provided steps presentation :
94+
95+
             [![Provided steps presentation](https://lh3.googleusercontent.com/proxy/xG_Nit5UEhPvdHnrMbYiLLJhbX0Di6qeDMDgBiDQt6mCblRvfbDi8UGQyvmzTi33Xdt0-oAPIa2hVxPUYVpf=w506-h285-n)](https://www.youtube.com/watch?v=gotnjNSVcaE)
96+
97+
Usage example :
98+
99+
             [![Usage example](https://lh3.googleusercontent.com/proxy/RwdveW5Zd1gPHjK0-imga_xMHp2Vgn7Roww1i1S7qlz0BA-do8CT8FLcIMg13kZ9vvurLmSZcRsH4OpXWaIq=w506-h285-n)](https://www.youtube.com/watch?v=IO0Chh0XjgY)
100+
101+
102+
Contributing
103+
---------------------
104+
***Reporting bugs***
105+
106+
1. First check if the version you used is the last one
107+
2. Next check if the issue has not ever been described in the [issues tracker](https://github.com/atolcd/pentaho-gis-plugins/issues)
108+
3. You can [create the issue](https://github.com/atolcd/pentaho-gis-plugins/issues/new)
109+
110+
***Submitting a Pull Request***
111+
112+
1. Fork the repository on GitHub
113+
2. Clone your repository (`git clone https://github.com/XXX/pentaho-gis-plugins.git && cd pentaho-gis-plugins`)
114+
3. Create a local branch that will support your dev (`git checkout -b a-new-dev`)
115+
4. Commit changes to your local branch branch (`git commit -am "Add a new dev"`)
116+
5. Push the branch to the central repository (`git push origin a-new-dev`)
117+
6. Open a [Pull Request][1]
118+
7. Wait for the PR to be supported
119+
74120

75121
LICENSE
76122
---------------------
77123
This extension is licensed under `GNU Library or "Lesser" General Public License (LGPL)`.
78124

79-
Developed by [Cédric Darbon](https://twitter.com/cedricdarbon) and packaged by [Charles-Henry Vagner](https://github.com/cvagner)
125+
Developed by [Cédric Darbon](https://twitter.com/cedricdarbon) and packaged by [Charles-Henry Vagner](https://github.com/cvagner)
80126

81127

82128
Our company
83129
---------------------
84-
[Atol Conseils et Développements](http://www.atolcd.com)
130+
[Atol Conseils et Développements](http://www.atolcd.com)
85131
Follow us on twitter [@atolcd](https://twitter.com/atolcd)

0 commit comments

Comments
 (0)