Directory Structure - gryphonshafer/Bible GitHub Wiki

The following is the directory structure for this project. Any line that ends with a "/" character is a directory. All other lines represent files.

Bible/
    Old Testament/
        Major Prophets/
            Daniel/
                Daniel 1
                Daniel 2
    New Testament/
        Pauline Epistles/
            Titus/
                Titus 1
                Titus 2
            Philemon
Work/
    Numbering/
        Hebrews 12
    Rephrasing/
        Hebrews 12 - Gryphon
        Obadiah
    Crossreferences/
        2 John
        3 John
    Footnotes/
        Hebrews 8
    Grammar/
        Hebrews 6
    Review/
        Hebrews 4 - Done
        Hebrews 5
    Hebrews 2
    Hebrews 3
README.md

Directory Conventions

Content while being worked upon is located under the "Work" directory. Under that directory, there are subdirectories for each type of work to be done. Files are chapter-based and move between work subdirectories based on what phase of work they need. Once initial translation work is complete for a given chapter, that chapter is published to the "Bible" directory under a testament, section, book subdirectory structure.

Files that are not under subdirectories but are directly under the "Work" directory are files that are being worked on using a different work flow and should be ignored for the purposes of the work flow described in these wiki pages.

"Claiming" Files

Prior to working on a file in a work subdirectory, it's recommended that the worker "claim" the file by putting "- Username" at the end of the file's name. This will indicate to others that the particular person is working on that file, and so changes to that file should not be made without first communicating with that person.

Done Files

When the phase of work for a given file is complete, the editor of the file should change it's name to include a "- Done" suffix to the file's name. This will help indicate that the file is ready for review and migration to the next work phase.