Skip to content

Latest commit

 

History

History
115 lines (74 loc) · 2.7 KB

README.md

File metadata and controls

115 lines (74 loc) · 2.7 KB

Probable Futures Open Data Documentation

Documentation for analysts, data scientists, software engineers, and other data-savvy people interested in exploring or building applications with Probable Futures maps and data.

Link to documentation site: https://docs.probablefutures.org/

Prerequisites

Before you begin, ensure you have the following installed:

  • Git: Used to clone the repository.
  • Homebrew: This is a package manager for macOS. If you're on a different platform, refer to the appropriate package manager.
  • Ruby: Jekyll is built with Ruby.

How to Run Locally

Follow these steps to get the project up and running on your local machine:

  1. Clone the Repository Navigate to the directory where you want to clone the repository and run:
git clone [email protected]:Probable-Futures/docs.git
cd docs
  1. Install and Configure Ruby

If you haven't already installed Ruby, follow these steps:

a. Install rbenv (Ruby Version Manager)

brew install rbenv

b. Configure Shell to Use rbenv If you're using bash:

echo ‘eval “$(rbenv init -)”‘ >> ~/.bash_profile

then

source ~/.bash_profile

If you're using zsh:

echo 'eval "$(rbenv init -)"' >> ~/.zshrc
source ~/.zshrc

c. Install Ruby Version 3.2.2:

rbenv install 3.2.2

then run

rbenv global 3.2.2
  1. Install Required Gems

With Ruby installed, run the following commands:

bundle install

and then run

gem install jekyll bundler

Serve the Project

With Jekyll and Bundler installed, navigate to the directory where you cloned the repository and run:

jekyll serve --livereload

This starts the Jekyll server with live-reloading enabled, allowing you to view live changes as you edit the project.

You should now be able to access the local version of the docs at http://localhost:4000/ or the URL provided in your terminal.

Contributing

Bug reports, proposals of new features, and pull requests are welcome on GitHub at https://github.com/probablefutures/docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Submitting code changes

  • Submit an Issue that motivates the changes, using the appropriate template
  • Discuss the proposed changes with other users and the maintainers
  • Open a Pull Request
  • Ensure all CI tests pass
  • Provide instructions to check the effect of the changes
  • Await code review