Skip to content

Commit

Permalink
Start porting over Wiki tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronbrethorst committed Feb 6, 2024
1 parent cdee965 commit d6c851d
Show file tree
Hide file tree
Showing 8 changed files with 1,052 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/_components/article_summary.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<div>
<h2>
<a href='<%= @link %>'>
<%= @title %>
</a>
</h2>

<p>
Last updated: <%= @date %>
<br>
<%= content %>
</p>
</div>
7 changes: 7 additions & 0 deletions src/_components/article_summary.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
class ArticleSummary < Bridgetown::Component
def initialize(title, link, date)
@title = title
@link = link
@date = date
end
end
1 change: 1 addition & 0 deletions src/_partials/_navbar.erb
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
<%= render(NavigationSection.new(
"Guides",
children: {
"Ported Wiki Guides" => '/guides/ported-wiki-guides',
"Quickstart" => '/guides/quickstart-guide',
"Installation" => '/guides/installation-guide',
"Transit Data Bundle" => '/guides/transit-data-bundle-guide',
Expand Down
57 changes: 57 additions & 0 deletions src/guides/ported-wiki-guides.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Guides from our Wikis
layout: page
---

<p>
Up until early 2024, the OneBusAway project had two primary sources of documentation:
our project wikis and this website. The wikis were much easier to update, but their
content has grown stale. Nevertheless, much of the information they contain is not
available anywhere else.
</p>

<p>
This page contains a list of every OneBusAway configuration guide that was previously
available on our project wikis. For each guide, you can find the name, original link,
date last updated, and some information about its purpose.
</p>

<%= render ArticleSummary.new(
"OBA 2.x Build and Run Guide (App Modules Wiki Home)",
'/guides/wiki/oba-2x-build-run-guide',
"April 2022"
) do %>
Intended to explain how to build and run OBA 2.x.
<% end %>


<%= render ArticleSummary.new(
"Configuration and Deployment Guide for v2.x",
'/guides/wiki/oba-2x-config-deploy-guide',
"October 2021"
) do %>
This guide is designed to provide a comprehensive deployment method for users who
wish to set up a simple OneBusAway application with minimal configurations. It is
primarily intended for use cases that would need to be more permanent than just
using the quick start version of OneBusAway. Unlike quick start, this solution
boots with the server automatically with no additional configuration required.
<% end %>

<%= render ArticleSummary.new(
"v1.x Developer Guide",
'/guides/wiki/oba-1x-developer-guide',
"October 2021"
) do %>
This guide is designed to get you up and running with the OneBusAway application
suite source code as quickly as possible.
<% end %>

<%= render ArticleSummary.new(
"GTFS Realtime Resources",
'/guides/wiki/gtfs-realtime-resources',
"January 2021"
) do %>
The OneBusAway application suite has support for both GTFS-realtime import and export.
The application suite can be used to provide a high-level API from low level GTFS and
GTFS-realtime data feeds, for example.
<% end %>
43 changes: 43 additions & 0 deletions src/guides/wiki/gtfs-realtime-resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: GTFS Realtime Resources
layout: page
---

<div class='bg-blue-50 border-blue-500 dark:bg-slate-800 p-4 rounded-md'>
<div><strong>Original location</strong>: <a href='https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Resources'>https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Resources</a></div>
<div><strong>Last updated</strong>: January 2021</div>
</div>


## Applications

The [OneBusAway application suite](https://github.com/OneBusAway/onebusaway-application-modules/wiki) has support for both GTFS-realtime import and export. The application suite can be used to provide a high-level API from low level GTFS and GTFS-realtime data feeds, for example.

## Tools and Libraries

We provide a number of libraries and tools for working with [GTFS-realtime](https://developers.google.com/transit/gtfs-realtime/) data:

* [**onebusaway-gtfs-realtime-api**](https://github.com/OneBusAway/onebusaway-gtfs-realtime-api/wiki) - a set of Java classes generated from the [GTFS-realtime Protocol Buffer spec](https://developers.google.com/transit/gtfs-realtime/gtfs-realtime-proto) that allow you to produce and consume raw GTFS-realtime data.
* [**onebusaway-gtfs-realtime-exporter**](https://github.com/OneBusAway/onebusaway-gtfs-realtime-exporter/wiki) provides a simple library to assist in sharing GTFS-realtime data.
* [**onebusaway-gtfs-realtime-from-siri-cli**](https://github.com/OneBusAway/onebusaway-gtfs-realtime-from-siri-cli/wiki) provides a command-line tool for converting [SIRI](http://siri.org.uk/) real-time data into GTFS-realtime.
* [**onebusaway-gtfs-realtime-from-nextbus-cli**](https://github.com/OneBusAway/onebusaway-gtfs-realtime-from-nextbus-cli/wiki) provide a command-line tool for converting [NextBus API](nextbus.com/xmlFeedDocs/NextBusXMLFeed.pdf) real-time data into GTFS-realtime.
* [**onebusaway-gtfs-realtime-munin-plugin**](https://github.com/OneBusAway/onebusaway-gtfs-realtime-munin-plugin/wiki) provides a [Munin](http://munin-monitoring.org/) plugin for logging information about a GTFS-realtime feed.
* [**onebusaway-gtfs-realtime-nagios-plugin**](https://github.com/OneBusAway/onebusaway-gtfs-realtime-nagios-plugin/wiki) provides a [Nagios](http://www.nagios.org/) plugin for monitoring a GTFS-realtime feed.

Also see a number of third-party tools [here](https://github.com/OneBusAway/onebusaway-application-modules/wiki/Real-Time-Data-Configuration-Guide#data-processing-tools).

## Tutorials

* A brief intro to GTFS-realtime and show how to produce a GTFS-realtime alerts feed: https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Tutorial-%231:-Intro-to-GTFS-Realtime
* How to produce GTFS-realtime trip update and vehicle position feeds: https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Tutorial-%232:-How-to-produce-GTFS-realtime-trip-update-and-vehicle-position-feed
* How to consume a GTFS-realtime feed, with a simple visualization of vehicle positions: https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Tutorial-%233:--Vehicle-Positions
* GTFS-realtime's place in the API ecosystem and using GTFS-realtime to power OneBusAway: https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Tutorial-%234:-GTFS-in-the-API-ecosystem
* A number of other GTFS-realtime resources, including various adapters and plugins that work with the spec: https://github.com/OneBusAway/onebusaway/wiki/GTFS-Realtime-Tutorial-%235:-Additional-Resources

## Example Code

We also provide a number of demonstration projects with example code designed to get your up and running with GTFS-realtime.

* [GTFS-realtime Alerts Producer Example Project](https://github.com/OneBusAway/onebusaway-gtfs-realtime-alerts-producer-demo/wiki)
* [GTFS-realtime Trip Updates and Vehicle Positions Producer Example Project](https://github.com/OneBusAway/onebusaway-gtfs-realtime-trip-updates-producer-demo/wiki)
* [GTFS-realtime Vehicle Positions Consumer Example Project](https://github.com/OneBusAway/onebusaway-gtfs-realtime-visualizer/wiki)
Loading

0 comments on commit d6c851d

Please sign in to comment.