This README file describes the tools under the /tools
directory of the bids-website repository.
- Install all Python requirements under
tools/requirements.txt
- Install pandoc
- Create a folder called
inputs
undertools
- Nest a folder with the year corresponding to the meeting notes you want to add (e.g.,
2023
) ininputs
- Getting the meeting notes
- Go to the Google Drive folder where the meeting notes you want to add are located
- See if you can make minor formatting tweaks (removing weird formatting, cleaning up tables, etc.)
- Download them as
.docx
files - Place all files in your "year" folder that you created above
- From the command line, navigate to
tools
, and then runmake all
- Clean up, check the newly added files, commit
There are two ways of creating Gantt charts for a BIDS timeline.
First install all Python requirements under tools/requirements.txt
.
Then, use one of the following two methods:
python -u tools/bep_gantt_html_create
creates a file:_pages/bids_timeline.html
that you can inspect in your browser. This file depends on thetools/timeline.csv
data, which you should keep up to date.python -u tools/bep_gantt_mermaid_insert
directly inserts code for a "mermaid" Gantt chart into the Get Involved page of the website. You can inspect how that chart looks by building the website using Jekyll and serving locally. This code depends on data from the filesbeps_completed.yml
files in the_data
directory. You should keep that file up to date.