Contributing to the TFResource
HI TFR REVIEWERS!
TFResource volunteers! Thanks for reviewing content for us!
Be sure to REMOVE the 'Needs Review' category line from the top of a page -- after you have verified it and made any necessary updates! 😃
Also check out the Tips for Reviewers for some quick fixes to common problems. Thank you!!!
This website serves as a community resource for travel forecasting research and practice. We welcome your participation!
This community is comprised of volunteers, many of whom are affiliated with the Transportation Research Board's ADB45 Committee for Travel Forecasting Resources.
# Getting started
TF Resource is a collection of pages written in Markdown plain-text format, stored on Github.com. Github uses a "pull request" workflow, which means that you don't need anyone's permission to suggest whatever changes you see fit! Rather, you make changes to your own copy of a page, and then you request that those changes be pulled into the site by our team of volunteers.
You must create a free account on GitHub in order to make changes to the site.
This removes the need for complicated permissions management or gatekeeping on the site, while still allowing the TFResource editors to prevent spam or incomplete/incorrect changes. After review, TFResource volunteers may then either approve/merge the edits or suggest additional changes.
# Should I edit directly on the Github website?
Small changes can be made directly on Github using the Edit this Page link at the top of every page.
For larger changes, we recommend following the detailed setup instructions to create a local copy of the site on your own computer. Then, you can iterate and verify changes locally on that copy before you request that they be published.
This will reduce the number of "round trips" while saving and publishing -- which will save you a lot of time.
# Editing a page
Click the Edit this Page link at the top of any page to create your own copy of the page and start editing.
- If you are not logged into GitHub, you will be asked to log in or create a new (free) account
- If this is the first time you are editing, you will be asked to Fork this repository. Yes, fork the repository. That means you are creating your own personal copy of the site, on which you can make whatever changes you wish.
You'll be taken to a page with the full text of that page in an editor window. Make changes as you see fit.
- Page text is in Markdown format, with standard Github-flavored extensions for tables and LaTeX/MathJax equations.
You can review your changes in the Preview Changes tab, but be warned that some content such as math equations and complex tables may not preview correctly. We wish we knew how to fix this! If you are doing lots of editing, you might want to build locally instead of using the web editor to get around this limitation.
When you are happy with your edits, save the file using the Propose file change button. You can add a description to the edits if you like.
GitHub will take you to a confirmation page which shows a "diff" of the lines you changed. If everything looks good, click Create Pull Request and sit back.
Someone at TFResource will review your changes and either approve, reject, or suggest further edits to your submission.
# Creating a new page
- To create a new page, you need to fork the content into a local copy on your hard drive as explained here.
- All pages must be stored in the
topicssubfolder of the site. Pages must be in Markdown format and must include a yaml header with the page title and any categories you want the page to be part of.
- Please name the file without any spaces or other non-alphanumeric characters.
- It is probably easiest to make a copy of an existing page, and start from that, instead of trying to create a blank page with the proper formatting from scratch.
# Uploading files and media
- For now, store all images and other attachments in the
.vuepress/public/topicsfolder. We're working on finding a better place for these items.
- After you've forked the repository, navigate on GitHub to the
.vuepress/public/topicsfolder in your repository, and click the
Upload Filesbutton to upload images.
- You can then refer to images using the syntax
[Image description](name_of_my_file.jpg "Optional Tooltip Text")
# Using categories for organization
- Please use categories!
- Please use categories that already exist! We have too many categories already, and don't need any more.
- Be sure to spell and capitalize all categories correctly to ensure that reviewers accept your changes.