Landing page for the Series REST-API #382

antego · 2017-05-20T20:42:05Z

Implementation of requested feature #134

(cherry picked from commit 9018961)

(cherry picked from commit ec8b3a0)

(cherry picked from commit 88f792b)

(cherry picked from commit e8f6855)

(cherry picked from commit dcc3a76)

…page Conflicts: rest/pom.xml spi-impl/series/series-dao-webapp/src/main/webapp/WEB-INF/spring/api_v1_mvc.xml spi-impl/series/series-dao-webapp/src/main/webapp/WEB-INF/spring/dispatcher-servlet.xml spi-impl/series/series-dao-webapp/src/main/webapp/WEB-INF/web.xml

antego · 2017-05-21T07:46:55Z

The merge conflict is because I've forgot to pull the changes from the upstream repo. Therefore I've edited the series-dao before It has been moved to the separate repo. @ridoo, can you tell me please in which SPI implementations the landing page should be added?

ridoo · 2017-05-22T12:59:10Z

I think, it would be nice if you create an extra module which can be overlayed in the webapp module of the actual SPI implementation.

Probably this module can be further used later on to add other stuff like Web API documentation (not sure if there is a Jekyll-Maven plugin which could trigger a site build on mvn install),

What do you think?

ridoo

move content to an extra module which can be overlayed (see examples on SOS webapp) on the actual webapp (like in dao-series-api)
make changes to avoid configuration conflicts

ridoo · 2017-05-22T13:03:18Z

rest/src/main/java/org/n52/web/ctrl/LandingPageController.java

+public class LandingPageController {
+    @RequestMapping
+    public String redirectToLandingPage() {
+        return "redirect:/api/";


this will break, if implementations choose different servlet contexts thant /api/* (see web.xml). You could configure the context, though, within the application.properties

ridoo · 2017-05-22T13:06:56Z

spi-impl/series/series-dao-webapp/src/main/webapp/WEB-INF/spring/dispatcher-servlet.xml

-<!--                 </bean> -->
+                 <bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
+                 <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
+                     <property name="prefix" value="/" />


use a prefix different from / just to separate API-related content from stuff the actual webapp ships.

Moved to the landing directory

antego · 2017-05-22T21:13:24Z

Yes, it makes sense to include resources in a common module. Also have found this maven-jekyll plugin. It can be an option, if the windows builds are not required.

ridoo · 2017-05-23T05:40:58Z

cool .. you could give it a try .. make sure that you place the plugin in a profile which is only run on Linux machines

antego · 2017-05-24T22:01:39Z

I can't build the proxy on the antego/series-sos-proxy@80327c5 commit.

[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[33,47] package org.n52.io.response.dataset.measurement does not exist
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[34,47] package org.n52.io.response.dataset.measurement does not exist
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[45,66] cannot find symbol
[ERROR] symbol: class MeasurementValue
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[60,12] cannot find symbol
[ERROR] symbol:   class MeasurementValue
[ERROR] location: class org.n52.proxy.db.da.ProxyMeasurementDataRepository
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[66,12] cannot find symbol
[ERROR] symbol:   class MeasurementValue
[ERROR] location: class org.n52.proxy.db.da.ProxyMeasurementDataRepository
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[72,15] cannot find symbol
[ERROR] symbol:   class MeasurementData
[ERROR] location: class org.n52.proxy.db.da.ProxyMeasurementDataRepository
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[78,15] cannot find symbol
[ERROR] symbol:   class MeasurementData
[ERROR] location: class org.n52.proxy.db.da.ProxyMeasurementDataRepository
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyTimeseriesRepository.java:[33,27] cannot find symbol
[ERROR] symbol:   class TimeseriesMetadataOutput
[ERROR] location: package org.n52.io.response
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyTimeseriesRepository.java:[50,15] cannot find symbol
[ERROR] symbol:   class TimeseriesMetadataOutput
[ERROR] location: class org.n52.proxy.db.da.ProxyTimeseriesRepository
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyMeasurementDataRepository.java:[43,8] cannot access org.n52.io.response.dataset.measurement.MeasurementData
[ERROR] class file for org.n52.io.response.dataset.measurement.MeasurementData not found
[ERROR] /home/anton/IdeaProjects/52north/series-sos-proxy/proxy-dao/src/main/java/org/n52/proxy/db/da/ProxyTimeseriesRepository.java:[44,8] cannot access org.n52.io.response.TimeseriesMetadataOutput
[ERROR] class file for org.n52.io.response.TimeseriesMetadataOutput not found

Did I forget to build something else?

ridoo · 2017-05-26T09:21:33Z

Please check if you are on the newest revision ... hint: have a look at other repositories available

antego · 2017-05-30T22:21:32Z

Copied the Jekyll docs to the new module for building them via the maven. Added the version label and link to source code.

ridoo · 2017-05-31T11:33:24Z

@antego could you please also create PR on the https://github.com/52North/dao-series-api repo showing how you integrated the new overlay module? Please reference the PR here so that one can reproduce what you are doing

antego · 2017-05-31T12:48:48Z

@ridoo could you tell me please which docs should be placed in a dao-series webapp? Currently the docs from the series-rest-api [0] is copied to the dao-webapp. Maybe I can add jekyll-generated docs [1] to the dao-webapp and leave a link to them from a landing page. [0] https://github.com/52North/series-rest-api/tree/develop/rest/src/main/webapp/api-doc [1] https://github.com/52North/series-rest-api/tree/develop/docs 2017-05-31 14:33 GMT+03:00 Henning Bredel <[email protected]>:

…

@antego <https://github.com/antego> could you please also create PR on the https://github.com/52North/dao-series-api repo showing how you integrated the new overlay module? Please reference the PR here so that one can reproduce what you are doing — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#382 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABYlyzjBm_meWQsk99EA8Xa7y-tberpFks5r_VAFgaJpZM4NhaJA> .

antego · 2017-05-31T16:57:27Z

@ridoo I've created a PR which integrates the new module into a webapp 52North/sensorweb-server-dao-impl#43.

antego added 9 commits May 18, 2017 23:22

Issue 52North#134 Add about page for the root path

8902b38

(cherry picked from commit 9018961)

Add landing page controller with redirection

18de11a

(cherry picked from commit ec8b3a0)

Fix resolving of views

85e1bd6

(cherry picked from commit 88f792b)

Rename landing page, fix maven build

fdbda9a

(cherry picked from commit e8f6855)

Rename landing page in web.xml

e2a759c

(cherry picked from commit dcc3a76)

Bootstrap template as landing page skeleton

2aa930d

More meaningful captions

d95175b

Add "learn more" section

c0713a9

ridoo requested changes May 22, 2017

View reviewed changes

ridoo mentioned this pull request May 22, 2017

Review Documentation #85

Open

antego added 4 commits May 30, 2017 00:45

resources moved under non root path

7d1dcd4

Jekyll integration in maven build

ed58f54

Move Jekyll build to the non-Windows profile

31bf062

Add GitHub repo ribbon and version label

cd0faa2

antego closed this May 31, 2017

antego reopened this May 31, 2017

Packaging resources in jar, link to jekyll docs

05ac325

antego mentioned this pull request May 31, 2017

Landing page 52North/sensorweb-server-dao-impl#43

Closed

Change packaging of module to war, fix urls

d3e1483

ridoo merged commit d3e1483 into 52North:develop Jun 15, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Landing page for the Series REST-API #382

Landing page for the Series REST-API #382

antego commented May 20, 2017

antego commented May 21, 2017

ridoo commented May 22, 2017

ridoo left a comment •

edited

Loading

ridoo May 22, 2017

antego May 30, 2017

ridoo May 22, 2017

antego May 30, 2017

antego commented May 22, 2017

ridoo commented May 23, 2017

antego commented May 24, 2017

ridoo commented May 26, 2017

antego commented May 30, 2017

ridoo commented May 31, 2017

antego commented May 31, 2017 via email •

edited

Loading

antego commented May 31, 2017

Landing page for the Series REST-API #382

Landing page for the Series REST-API #382

Conversation

antego commented May 20, 2017

antego commented May 21, 2017

ridoo commented May 22, 2017

ridoo left a comment • edited Loading

Choose a reason for hiding this comment

ridoo May 22, 2017

Choose a reason for hiding this comment

antego May 30, 2017

Choose a reason for hiding this comment

ridoo May 22, 2017

Choose a reason for hiding this comment

antego May 30, 2017

Choose a reason for hiding this comment

antego commented May 22, 2017

ridoo commented May 23, 2017

antego commented May 24, 2017

ridoo commented May 26, 2017

antego commented May 30, 2017

ridoo commented May 31, 2017

antego commented May 31, 2017 via email • edited Loading

antego commented May 31, 2017

ridoo left a comment •

edited

Loading

antego commented May 31, 2017 via email •

edited

Loading