Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update extension tracker URL from wiki to gbfs.org #60

Merged
merged 2 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/specification/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,17 @@ The following items have passed through the voting process and will be included

<hr>

## Extensions Outside of the Specification

To accommodate the needs of feed producers and consumers prior to the adoption of a change, additional fields can be added to feeds even if these fields are not part of the official specification. Custom extensions that may provide value to the GBFS community and align with the [GBFS Guiding Principles](https://github.com/MobilityData/gbfs/blob/master/README.md#guiding-principles) should be proposed for inclusion in the specification through the change process.

Field names of extensions should be prefixed with an underscore (_) character. It is strongly recommended that these additional fields be documented here in this format:
<iframe class="airtable-embed" src="https://airtable.com/embed/appLjB8xGZMERTzIr/shrPitUb0EBDGrwjN?backgroundColor=red&viewControls=on" frameborder="0" onmousewheel="" width="100%" height="333" style="background: transparent; border: 1px solid #ccc;"></iframe>

<a class="button no-icon" href="https://airtable.com/appLjB8xGZMERTzIr/shrsxVUGzo3NhXsn6" target="_blank">Add your custom extension</a>

<hr>

## Change Proposals

GBFS is an open source project developed under a consensus-based governance model. Contributors come from across the shared mobility industry, public sector, civic technology and elsewhere. An overview of current work can be found on the [Project Roadmap](https://github.com/NABSA/gbfs/wiki/Project-Roadmap). Comments or questions can be addressed to the community by [opening an issue](https://github.com/NABSA/gbfs/issues) on the GBFS GitHub repo. Proposals for changes or additions to the specification can be made through [pull requests](https://github.com/NABSA/gbfs/pulls).
Expand Down
6 changes: 3 additions & 3 deletions docs/specification/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,11 @@ Example: `Asia/Tokyo`, `America/Los_Angeles` or `Africa/Cairo`.

To accommodate the needs of feed producers and consumers prior to the adoption of a change, additional fields can be added to feeds even if these fields are not part of the official specification. Custom extensions that may provide value to the GBFS community and align with the [GBFS Guiding Principles](https://github.com/MobilityData/gbfs/blob/master/README.md#guiding-principles) SHOULD be proposed for inclusion in the specification through the change process. Extreme caution is advised to avoid introducing extensions which may be used to track the movements of vehicles or their users.

Field names of extensions SHOULD be prefixed with an underscore ( _ ) character. It is strongly RECOMMENDED that these additional fields be documented on the [wiki](https://github.com/MobilityData/gbfs/wiki) page of the GBFS repository in this format:
Field names of extensions SHOULD be prefixed with an underscore (_) character. It is strongly RECOMMENDED that these additional fields be documented on [gbfs.org](https://gbfs.org/specification/#extensions-outside-of-the-specification) in this format:

Submitted by | Field Name | File Name | Defines
Field Name | File Name | Organization name | Defines
---|---|---|---
Publisher's name|_field_name|Name of GBFS endpoint where field is used|Description of purpose of use
_field_name | Name of GBFS endpoint where field is used | Publisher's name | Description of purpose or use

## JSON Files

Expand Down