Update the "Configuration and Deployment Guide for v2.x" Document

aaronbrethorst commented 6 months ago

Is your feature request related to a problem? Please describe

The Configuration and Deployment Guide for v2.x document, which can be found at https://developer.onebusaway.org/guides/wiki/oba-2x-config-deploy-guide, is out of date. For instance, it specifies using JDK 8 even though the latest version of OBA now requires JDK 11.

Describe the solution you'd like

This document needs to be updated to reflect the latest changes to OBA, which can likely be synthesized from the Dockerfile found here: https://github.com/OneBusAway/onebusaway-docker/blob/main/oba/Dockerfile

The document should mention that unless you have a really good reason for doing it manually, you should be using the official Docker image.
The download location will need to change. luckily, you can find the latest versions on the downloads page, which will be here on your dev server: http://localhost:4000/downloads
The data-sources.xml files should mirror the latest changes in the docker repo. Let me know if you have questions about what this should look like.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

gorgwu commented 6 months ago

I'll begin working on this in the next few days.

ankitkumar748846 commented 6 months ago

Please assign me this issue sir I will work on it @aaronbrethorst

tarunsinghofficial commented 6 months ago

I can do this, please assign it to me. Thanks

gorgwu commented 6 months ago

Just for clarification, for the 3 data-sources.xml files found in the page, am I simply updating it by copying over the code from

oba/config/onebusaway-api-webapp-data-sources.xml
oba/config/onebusaway-enterprise-acta-webapp-data-sources.xml
oba/config/onebusaway-transit-data-federation-webapp-data-sources.xml

from the docker repo and pasting it over the corresponding outdated code? (I'm referring to that last bullet point from the original comment)

aaronbrethorst commented 6 months ago

@gorgwu not entirely. the data-sources.xml files that are contained in the Docker repo are incomplete because they get filled in with data at runtime. your best bet would be to spin up a docker container, preferably with GTFS-RT feeds, get a shell into the docker container, and inspect the three data-sources.xml files

gorgwu commented 6 months ago

@aaronbrethorst edit - I believe I've mostly finished updating the guide, made a pull request with the changes

OneBusAway / onebusaway-docs