Home

Welcome to the hsg-project wiki! This wiki will walk you through how to set up, work with, and maintain an up-to-date history.state.gov (HSG) Development Environment on your computer.

Getting started

1. Setting up an HSG Development Environment on your computer (see also the Training checklist)
2. Updating the HSG Development Environment on your computer

Working with HSG Publications and Datasets

1. Getting the latest data and saving your work (version control)
2. FRUS TEI GitHub repository, including schema (see also the FRUS TEI Guidelines)
3. New FRUS volumes: Publishing to website (FRUS TEI Files)
4. New FRUS volumes: Reviewing (FRUS TEI Files)
5. eBooks: Generating, reviewing, and publishing
6. FRUS quarterly releases: Steps in preparing quarterly releases
7. Travels & Visits: Converting MS Word submissions into XML

Other resources

• Training checklist: A checklist for trainers and trainees
• Bookmarklets: For your browser's bookmarks bar, to quickly switch between preview and live site
• Homebrew: Information on our use of Homebrew and apps available via Homebrew
• Converting files to XML: How to convert Word, PDF, and other Office files to XML
• VSFS: Getting VSFS students set up to contribute with GitHub
• Troubleshooting: Quick fixes to common problems

Editing this wiki

Have an idea for improving a page or spot a problem? Great! There is plenty of room for improving our directions, procedures, and FAQs. Once you've made your edits, just drop Joe a note with a link to the page. Everyone depends on these directions for their work, so he reviews all edits for things that may need additional testing. Unlike our regular repositories, edits to the wiki don't generate email notifications, so it's easy to miss these edits. Indeed, once a substantive change has been applied, we often circulate an email to let everyone know about the new procedure, improved directions, etc. Have questions about a particularly substantive edit you're thinking about? Just reach out to Joe.