Skip to content

Commit

Permalink
Move /docs to /doc/user
Browse files Browse the repository at this point in the history
  • Loading branch information
t2gran committed Jul 24, 2024
1 parent 7709343 commit 564d9b0
Show file tree
Hide file tree
Showing 136 changed files with 422 additions and 418 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Write a few words on how the new code is tested.
- Was the code designed so it is unit testable?
- Were any tests applied to the smallest appropriate unit?
- Do all tests
pass [the continuous integration service](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/docs/Developers-Guide.md#continuous-integration)
pass [the continuous integration service](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/doc/user/Developers-Guide.md#continuous-integration)
?

### Documentation
Expand All @@ -59,7 +59,7 @@ Write a few words on how the new code is tested.

### Changelog

The [changelog file](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/docs/Changelog.md)
The [changelog file](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/doc/user/Changelog.md)
is generated from the pull-request title, make sure the title describe the feature or issue fixed.
To exclude the PR from the changelog add the label `skip changelog` to the PR.

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cibuild.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ jobs:
if: github.event_name == 'pull_request'

- name: Install Python dependencies
run: pip install -r docs/requirements.txt
run: pip install -r doc/user/requirements.txt


- name: Build main documentation
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/post-merge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ jobs:
run: |
# add a line above the one which contains AUTOMATIC_CHANGELOG_PLACEHOLDER
ITEM="${TITLE} [#${NUMBER}](${URL})"
TEMP_FILE=docs/Changelog.generated.md
FILE=docs/Changelog.md
TEMP_FILE=doc/user/Changelog.generated.md
FILE=doc/user/Changelog.md
awk "/CHANGELOG_PLACEHOLDER/{print \"- $ITEM\"}1" $FILE > $TEMP_FILE
mv $TEMP_FILE $FILE
git add $FILE
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ o_o_standalone_config_IncludeFileDirectiveTest_part.json
_site/
build/
dist/
docs/_build/
doc/user/_build/
gen-java/
gen-javabean/
gen-py/
Expand Down
4 changes: 2 additions & 2 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ We document [Decision Records](DECISION_RECORDS.md) in a log. Make sure you as a
with the decisions and follow them. Reviewers should use them actively when reviewing code and may
use them to ask for changes.

Be sure to also read the [developer documentation](docs/Developers-Guide.md).
Be sure to also read the [developer documentation](doc/user/Developers-Guide.md).

## Modules/Components

The diagram shows a simplified/generic version on how we want to model the OTP components with 2
examples. The Transit model is more complex than the VehiclePosition model.

![MainModelOverview](docs/images/ServiceModelOverview.png)
![MainModelOverview](doc/user/images/ServiceModelOverview.png)

- `Use Case Service` A service which combine the functionality in many `Domain Services` to fulfill
a use-case or set of features. It may have an api with request/response classes. These are
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPMENT_DECISION_RECORDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ notes on `private` members and as inline comments.
> If you decide to NOT follow these decision records, then you must document why.
**See also**
- [Developers-Guide > Code comments](docs/Developers-Guide.md#code-comments).
- [Developers-Guide > Code comments](doc/user/Developers-Guide.md#code-comments).
- [Codestyle > Javadoc Guidlines](doc/dev/decisionrecords/Codestyle.md#javadoc-guidlines) - JavaDoc checklist


Expand Down
2 changes: 1 addition & 1 deletion doc/dev/decisionrecords/Codestyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Editor > Code Style_. Then select **Project** in the \_Scheme drop down.
You can run the Prettier Maven plugin as an external tool in IntelliJ. Set it up as an
`External tool` and assign a key-shortcut to the tool execution.

![External Tool Dialog](../../../docs/images/ExternalToolDialog.png)
![External Tool Dialog](../../../doc/user/images/ExternalToolDialog.png)

```
Name: Prettier Format Current File
Expand Down
2 changes: 1 addition & 1 deletion doc/dev/decisionrecords/NamingConventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ These prefixes are also "allowed", but not preferred - they have some kind of ne

## Service, Model and Repository

![MainModelOverview](docs/images/ServiceModelOverview.png)
![MainModelOverview](doc/user/images/ServiceModelOverview.png)



Expand Down
2 changes: 1 addition & 1 deletion docs/Accessibility.md → doc/user/Accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ inaccessible to wheelchair users.
## Example

A full configuration example is available
at [`/docs/examples`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/docs/examples/ibi)
at [`/docs/examples`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/doc/user/examples/ibi)
File renamed without changes.
414 changes: 207 additions & 207 deletions docs/Basic-Tutorial.md → doc/user/Basic-Tutorial.md

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
192 changes: 96 additions & 96 deletions docs/Deployments.md → doc/user/Deployments.md
Original file line number Diff line number Diff line change
@@ -1,96 +1,96 @@
# OpenTripPlanner Deployments Worldwide

## Official Production

The following are known deployments of OTP in a government- or agency-sponsored production capacity:

* **Norway (nationwide)** Since November 2017, the national integrated ticketing agency Entur has
prodvided a [national journey planner](https://en-tur.no/) which consumes schedule data in the EU
standard NeTEx format with SIRI real-time updates. Entur has contributed greatly to the OTP2 effort
and primarily uses OTP2 in production, handling peak loads in excess of 20 requests per second.
Most regional agencies in Norway, like **Ruter, Oslo area** uses OTP as a service provided by Entur.
* **Finland (nationwide)** The [Helsinki Regional Transport Authority](https://www.reittiopas.fi/),
the [Finnish Transport Agency](https://opas.matka.fi/), and
other [Finnish cities](https://waltti.fi/?lang=en) have collaborated to
create [Digitransit](https://digitransit.fi/en/), providing OTP-based trip planners, APIs, open
data, Docker containers and open source code. Each member organisation runs its own instance of a
shared codebase and deployment environment. Their source code is
available [on Github](https://github.com/HSLdevcom/), including
a [new custom UI](https://github.com/HSLdevcom/digitransit-ui). This system also has a strong
real-time component.
* **Finland Intercity** The Finnish intercity coach
service [Matkahuolto](https://en.wikipedia.org/wiki/Matkahuolto)
has [developed a trip planner in partnership with Kyyti](https://www.kyyti.com/matkahuoltos-new-app-brings-real-travel-chains-within-the-reach-of-citizens-in-addition-to-coach-travel-hsl-tickets-are-also-available/).
* **Skåne, Sweden**, the JourneyPlanner and mobile app for the regional transit agency [Skånetrafiken](https://www.skanetrafiken.se/)
uses OTP2 with the nordic profile of NeTEx and SIRI for real-time updates.
* [**Northern Colorado**](https://discover.rideno.co/)
* [**Philadelphia and surrounding areas**](https://plan.septa.org)
* **Portland, Oregon** TriMet is the agency that originally started the OpenTripPlanner project.
Their [Regional Trip Planner](http://ride.trimet.org) is based on OTP and provides about 40,000
trip plans on a typical weekday.
* [**New York City**](https://new.mta.info/)
* **New York State** The State Department of
Transportation's [transit trip planner](https://511ny.org/#TransitRegion-1) provides itineraries
for public transit systems throughout the state in a single unified OTP instance.
* **Los Angeles, California** The new [metro.net trip planner](https://www.metro.net/).
* **Atlanta, Georgia** The Metropolitan Atlanta Rapid Transit Authority's (
MARTA) [trip planner](http://itsmarta.com/planatrip.aspx) and the Atlanta region's transit
information hub [https://atlrides.com/](https://atlrides.com/) both use OTP to power their website trip
planners.
* **Boston, Massachusetts**
The [Massachusetts Bay Transportation Authority trip planner](https://www.mbta.com/trip-planner).
* **Seattle, Washington** The [Sound Transit Trip Planner](https://www.soundtransit.org/tripplanner)
is based on OTP. OTP also powers the trip planning feature of
the [OneBusAway native apps](http://onebusaway.org/) in the Puget Sound region. Technical details
are [here](https://github.com/OneBusAway/onebusaway-android/blob/master/SYSTEM_ARCHITECTURE.md#add-trip-planning-andor-bike-share-optional)
.
* [**Ride Metro Houston**](https://planyourtrip.ridemetro.org/)
* **Tampa, Florida** Hillsoborough Area Regional Transit uses an OpenTripPlanner server to power the
trip planning feature of the [OneBusAway native apps](http://onebusaway.org/) in their region.
Technical details
are [here](https://github.com/OneBusAway/onebusaway-android/blob/master/SYSTEM_ARCHITECTURE.md#add-trip-planning-andor-bike-share-optional)
.
* [**Piemonte Region, Italy**](https://map.muoversinpiemonte.it/#planner) and the [**City of
Torino**](https://www.muoversiatorino.it/) built on OpenTripPlanner
by [5T](http://www.5t.torino.it/).
* [**Valencia, Spain**](http://www.emtvalencia.es/geoportal/?lang=en_otp) from the Municipal
Transport Company of Valencia S.A.U.
* [**Grenoble, France**](http://www.metromobilite.fr/) from SMTC, Grenoble Alpes métropole, l'État
Français, the Rhône-alpes region, the Isère council and the City of Grenoble.
* **Rennes, France** where the STAR network provides an OTP client
for [iOS](https://itunes.apple.com/us/app/starbusmetro/id899970416?mt=8)
, [Android](https://play.google.com/store/apps/details?id=com.bookbeo.starbusmetro), Windows Phone
et Web.
* **Alençon, France** integrated urban and school bus
network [planner from Réunir Alençon](https://altobus.com/mon-itineraire/).
* [**Poznań, Poland**](http://ztm.poznan.pl/#planner) from Urban Transport Authority of Poznań (ZTM
Poznan).
* **Trento Province, Italy**
- [ViaggiaTrento](https://play.google.com/store/apps/details?id=eu.trentorise.smartcampus.viaggiatrento)
and [ViaggiaRovereto](https://play.google.com/store/apps/details?id=eu.trentorise.smartcampus.viaggiarovereto)
were implemented as part of the [SmartCampus Project](http://www.smartcampuslab.it), a research
project founded by [TrentoRise](http://trentorise.eu), [UNITN](http://www.unitn.it),
and [FBK](http://www.fbk.eu).
* **University of South Florida** (Tampa, Florida). The [USF Maps App](https://maps.usf.edu/) is a
responsive web application for that helps university students, staff, and visitors find their way
around the campus using multiple modes of transportation, including the USF Bull Runner campus
shuttle, Share-A-Bull bike share, and pedestrian pathways.
Open-sourced [on Github](https://github.com/CUTR-at-USF/usf-mobullity).
* **Lower Saxony, Germany** The [VBN](https://www.vbn.de/en/) transportation authority offers an [OTP instance](https://www.vbn.de/en/service/developer-information/opendata-and-openservice) as alternative to the [Hafas](https://www.hacon.de/en/portfolio/information-ticketing/#section_8294) passenger information system.
* **Leipzig, Germany** As of summer 2020 [Leipzig Move](https://leipzig-move.de/) has been using
OpenTripPlanner.

## Independent Production

The following OTP-based services are presented as production-quality deployments, but are not backed
by an official transportation authority or government. OTP is also known to be used on the back end
of several popular multi-city mobile trip planning applications.

* **The Netherlands (nationwide)** [Plannerstack Foundation](http://www.plannerstack.org/) provides
national scale trip planning APIs using OTP and other open source trip planners, based
on [OpenOV's extremely detailed open data](http://gtfs.openov.nl/) including minutely real-time
updates for every vehicle in the country.
* [OTP Android](https://play.google.com/store/apps/details?id=edu.usf.cutr.opentripplanner.android)
by CUTR-USF and Vreixo González can find itineraries on many different OTP servers via a service
discovery mechanism.
* [**ViviBus Bologna**](http://www.vivibus.it/) Bologna, Italy.
# OpenTripPlanner Deployments Worldwide

## Official Production

The following are known deployments of OTP in a government- or agency-sponsored production capacity:

* **Norway (nationwide)** Since November 2017, the national integrated ticketing agency Entur has
prodvided a [national journey planner](https://en-tur.no/) which consumes schedule data in the EU
standard NeTEx format with SIRI real-time updates. Entur has contributed greatly to the OTP2 effort
and primarily uses OTP2 in production, handling peak loads in excess of 20 requests per second.
Most regional agencies in Norway, like **Ruter, Oslo area** uses OTP as a service provided by Entur.
* **Finland (nationwide)** The [Helsinki Regional Transport Authority](https://www.reittiopas.fi/),
the [Finnish Transport Agency](https://opas.matka.fi/), and
other [Finnish cities](https://waltti.fi/?lang=en) have collaborated to
create [Digitransit](https://digitransit.fi/en/), providing OTP-based trip planners, APIs, open
data, Docker containers and open source code. Each member organisation runs its own instance of a
shared codebase and deployment environment. Their source code is
available [on Github](https://github.com/HSLdevcom/), including
a [new custom UI](https://github.com/HSLdevcom/digitransit-ui). This system also has a strong
real-time component.
* **Finland Intercity** The Finnish intercity coach
service [Matkahuolto](https://en.wikipedia.org/wiki/Matkahuolto)
has [developed a trip planner in partnership with Kyyti](https://www.kyyti.com/matkahuoltos-new-app-brings-real-travel-chains-within-the-reach-of-citizens-in-addition-to-coach-travel-hsl-tickets-are-also-available/).
* **Skåne, Sweden**, the JourneyPlanner and mobile app for the regional transit agency [Skånetrafiken](https://www.skanetrafiken.se/)
uses OTP2 with the nordic profile of NeTEx and SIRI for real-time updates.
* [**Northern Colorado**](https://discover.rideno.co/)
* [**Philadelphia and surrounding areas**](https://plan.septa.org)
* **Portland, Oregon** TriMet is the agency that originally started the OpenTripPlanner project.
Their [Regional Trip Planner](http://ride.trimet.org) is based on OTP and provides about 40,000
trip plans on a typical weekday.
* [**New York City**](https://new.mta.info/)
* **New York State** The State Department of
Transportation's [transit trip planner](https://511ny.org/#TransitRegion-1) provides itineraries
for public transit systems throughout the state in a single unified OTP instance.
* **Los Angeles, California** The new [metro.net trip planner](https://www.metro.net/).
* **Atlanta, Georgia** The Metropolitan Atlanta Rapid Transit Authority's (
MARTA) [trip planner](http://itsmarta.com/planatrip.aspx) and the Atlanta region's transit
information hub [https://atlrides.com/](https://atlrides.com/) both use OTP to power their website trip
planners.
* **Boston, Massachusetts**
The [Massachusetts Bay Transportation Authority trip planner](https://www.mbta.com/trip-planner).
* **Seattle, Washington** The [Sound Transit Trip Planner](https://www.soundtransit.org/tripplanner)
is based on OTP. OTP also powers the trip planning feature of
the [OneBusAway native apps](http://onebusaway.org/) in the Puget Sound region. Technical details
are [here](https://github.com/OneBusAway/onebusaway-android/blob/master/SYSTEM_ARCHITECTURE.md#add-trip-planning-andor-bike-share-optional)
.
* [**Ride Metro Houston**](https://planyourtrip.ridemetro.org/)
* **Tampa, Florida** Hillsoborough Area Regional Transit uses an OpenTripPlanner server to power the
trip planning feature of the [OneBusAway native apps](http://onebusaway.org/) in their region.
Technical details
are [here](https://github.com/OneBusAway/onebusaway-android/blob/master/SYSTEM_ARCHITECTURE.md#add-trip-planning-andor-bike-share-optional)
.
* [**Piemonte Region, Italy**](https://map.muoversinpiemonte.it/#planner) and the [**City of
Torino**](https://www.muoversiatorino.it/) built on OpenTripPlanner
by [5T](http://www.5t.torino.it/).
* [**Valencia, Spain**](http://www.emtvalencia.es/geoportal/?lang=en_otp) from the Municipal
Transport Company of Valencia S.A.U.
* [**Grenoble, France**](http://www.metromobilite.fr/) from SMTC, Grenoble Alpes métropole, l'État
Français, the Rhône-alpes region, the Isère council and the City of Grenoble.
* **Rennes, France** where the STAR network provides an OTP client
for [iOS](https://itunes.apple.com/us/app/starbusmetro/id899970416?mt=8)
, [Android](https://play.google.com/store/apps/details?id=com.bookbeo.starbusmetro), Windows Phone
et Web.
* **Alençon, France** integrated urban and school bus
network [planner from Réunir Alençon](https://altobus.com/mon-itineraire/).
* [**Poznań, Poland**](http://ztm.poznan.pl/#planner) from Urban Transport Authority of Poznań (ZTM
Poznan).
* **Trento Province, Italy**
- [ViaggiaTrento](https://play.google.com/store/apps/details?id=eu.trentorise.smartcampus.viaggiatrento)
and [ViaggiaRovereto](https://play.google.com/store/apps/details?id=eu.trentorise.smartcampus.viaggiarovereto)
were implemented as part of the [SmartCampus Project](http://www.smartcampuslab.it), a research
project founded by [TrentoRise](http://trentorise.eu), [UNITN](http://www.unitn.it),
and [FBK](http://www.fbk.eu).
* **University of South Florida** (Tampa, Florida). The [USF Maps App](https://maps.usf.edu/) is a
responsive web application for that helps university students, staff, and visitors find their way
around the campus using multiple modes of transportation, including the USF Bull Runner campus
shuttle, Share-A-Bull bike share, and pedestrian pathways.
Open-sourced [on Github](https://github.com/CUTR-at-USF/usf-mobullity).
* **Lower Saxony, Germany** The [VBN](https://www.vbn.de/en/) transportation authority offers an [OTP instance](https://www.vbn.de/en/service/developer-information/opendata-and-openservice) as alternative to the [Hafas](https://www.hacon.de/en/portfolio/information-ticketing/#section_8294) passenger information system.
* **Leipzig, Germany** As of summer 2020 [Leipzig Move](https://leipzig-move.de/) has been using
OpenTripPlanner.

## Independent Production

The following OTP-based services are presented as production-quality deployments, but are not backed
by an official transportation authority or government. OTP is also known to be used on the back end
of several popular multi-city mobile trip planning applications.

* **The Netherlands (nationwide)** [Plannerstack Foundation](http://www.plannerstack.org/) provides
national scale trip planning APIs using OTP and other open source trip planners, based
on [OpenOV's extremely detailed open data](http://gtfs.openov.nl/) including minutely real-time
updates for every vehicle in the country.
* [OTP Android](https://play.google.com/store/apps/details?id=edu.usf.cutr.opentripplanner.android)
by CUTR-USF and Vreixo González can find itineraries on many different OTP servers via a service
discovery mechanism.
* [**ViviBus Bologna**](http://www.vivibus.it/) Bologna, Italy.
2 changes: 1 addition & 1 deletion docs/Developers-Guide.md → doc/user/Developers-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ compile and test the new code, providing feedback on the stability of the build.

### Changelog workflow

The [changelog file](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/docs/Changelog.md)
The [changelog file](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/doc/user/Changelog.md)
is generated from the pull-request(PR) _title_ using the
[changelog workflow](https://github.com/opentripplanner/OpenTripPlanner/actions/workflows/automatic-changelog.yml)
. The workflow runs after the PR is merged, and it changes, commits and pushes the _Changelog.md_. A
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 564d9b0

Please sign in to comment.