Skip to content

Latest commit

 

History

History
 
 

tools

Tools for working with bids-website

This README file describes the tools under the /tools directory of the bids-website repository.

Adding Steering Group meeting notes

  1. Install all Python requirements under tools/requirements.txt
  2. Install pandoc
  3. Create a folder called inputs under tools
  4. Nest a folder with the year corresponding to the meeting notes you want to add (e.g., 2023) in inputs
  5. Getting the meeting notes
    1. Go to the Google Drive folder where the meeting notes you want to add are located
    2. See if you can make minor formatting tweaks (removing weird formatting, cleaning up tables, etc.)
    3. Download them as .docx files
    4. Place all files in your "year" folder that you created above
  6. From the command line, navigate to tools, and then run make all
  7. Clean up, check the newly added files, commit

Update the Gantt chart of completed BEPs

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:

  1. 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 the tools/timeline.csv data, which you should keep up to date.
  2. 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 files beps_completed.yml files in the _data directory. You should keep that file up to date.