onebusaway-docs

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

onebusaway-docs

★ 14 Open GitHub ↗

Official developer documentation for OneBusAway

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OneBusAway Developer Documentation

Welcome to the GitHub project that powers the official [OneBusAway Developer Documentation](http://developer.onebusaway.org).

## Quick Start

Clone the repository:

```sh
git clone https://github.com/OneBusAway/onebusaway-docs.git
cd onebusaway-docs
bundle install
yarn install
bin/bridgetown start

## Improve the Documentation

Want to help improve the documentation? Thank you! You can easily improve the official OneBusAway documentation by modifying the Markdown files that comprise it. We welcome any size of contribution, ranging from typos and corrected links, to brand-new tutorials.

## Import Javadocs from OBA Sites

From the root of the project, run the command `bin/update_javadocs` to see a list of available projects from which Javadocs can be imported.

## Develop New Features/Fix Bugs

### Prerequisites

Ensure you have the following installed on your system:

- [Ruby](https://www.ruby-lang.org/en/downloads/) (version >= 2.7)
- [Node.js](https://nodejs.org) (version >= 12)
- [Yarn](https://yarnpkg.com)

### Setting Up Development Environment

#### For Windows Users (via Windows Subsystem for Linux - WSL)

1. Install the [Windows Subsystem for Linux (WSL)](https://gorails.com/setup/windows/10) if you haven't already.
2. After setting up WSL, navigate to the project directory in your Linux subsystem.
3. Fork the repository by clicking the "Fork" button on the [repository page](https://github.com/OneBusAway/onebusaway-docs).
4. Clone the forked repository:

```sh
    git clone https://github.com/YourUsername/onebusaway-docs.git
    cd onebusaway-docs
    ```

5. Install dependencies:

```sh
    bundle install
    yarn install
    ```

If you encounter any errors, you may run:

```sh
    yarn add glob
    ```

6. If CSS is not working properly, rebuild frontend assets:

```sh
    bin/bridgetown frontend:build
    ```

#### For Linux Users

1. Fork and clone the repository as described above.
2. Navigate to the project directory.
3. Install dependencies:

```sh
    bundle install
    yarn install
    ```

### Development

To start the site in development mode, run:

```sh
bin/bridgetown start
```

### Additional Commands

Load the site up within a Ruby console (IRB)

```sh
bin/bridgetown console
```

> Learn more: [Bridgetown CLI Documentation](https://www.bridgetownrb.com/docs/command-line-usage)

## Deployment

The website built from this project is deployed automatically to a static hosting service on [Render](https://www.render.com). Please contact the maintainers with any questions.
## Creating an issue.

- Search existing issues before creating a new one.
- Provide clear reproduction steps.
- Include screenshots if relevant.

## Development Workflow.

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Test locally.
5. Commit with a clear message.
6. Push to your fork.

## Create a pull request.

- Ensure your branch is up to date.
- Keep changes focused and small.
- Add a meaningful title and description.
- Reference related issues if applicable.

> Please note: maintainers may close your PR if it has gone stale or if we don't plan to merge the code.

## Pull request reviews
- Requested changes must be resolved (with code or discussion) before merging.
- If you make changes to a PR, be sure to re-request a review.
- Don't repeadetely tag someone(may be it is not the right time to review your PR), be patient.
- Do not 'resolve conversation' unnecessary raised by a community member or any workflow tools(codeclimate or hound) as they may have some purpose, try to resolve the request changes and if any help wanted tag a community member to give views about that.

### Code Contributors

This project exists because of all the people who have contributed.

## The bottom line

We are all humans trying to work together to improve the community. Let's always be kind and appreciate the importance of making compromises. ❤️

onebusaway-docs

Today's picks

Was this content helpful?

Recent Feedback

onebusaway-docs

Today's picks

Was this content helpful?

Recent Feedback

Download README