Quickstart

This information is now outdated -- the page is under construction

Improved and Updated Git Workflow for SigiDoc-based projects

Initial Setup

1. Create a GitHub Account

   • Create a GitHub account for your collection’s organization or use a personal one.
   • If you cannot do this yourself, ask someone with a GitHub account to assist.

2. Forking Repositories

   • Log in to your GitHub account and fork the SigiDoc/EFES-SigiDoc and SigiDoc/Authority repositories.

3. Cloning Repositories

   • Use GitHub Desktop to clone your forks of the EFES-SigiDoc and Authority repositories onto your local machine.

4. Creating the Collection Repository

   • Use GitHub Desktop to create a repository for your collection, placing it within the EFES-SigiDoc repository at webapps/ROOT/content/xml/epidoc.

Working on the Collection

1. Adding/Editing XML Files

   • Edit your XML files within the collection repository on your computer.
   • Use GitHub Desktop to commit and push your changes to the collection repository on GitHub.

2. Modifying the Authority List

   • If changes are needed in the Authority list, make these adjustments in your local copy of the Authority repository.
   • Commit and push these changes to GitHub, then create a pull request (PR) to propose these changes to the main SigiDoc/Authority repository.

   Note: Regularly submit pull requests to ensure your data is included in the federated search portal.

3. Updating Authority Files

   • Regularly pull/merge changes from the central SigiDoc/Authority repository into your fork to stay updated with changes made by others.

4. Customizing EFES

   • Customize the EFES appearance (e.g., adding your collection logo) in your fork of the EFES-SigiDoc repository.
   • Regularly update your fork by pulling changes from the central SigiDoc/EFES-SigiDoc repository.

Git Glossary for Byzantinists

• Clone: Downloading a copy of a repository to your local machine.
• Fork: Creating your own copy of a repository on GitHub.
• Push: Uploading local commits to a remote repository.
• Pull: Fetching and merging changes from a remote repository.
• Fetch: Downloading objects and refs from another repository.
• Repository (Repo): A directory or storage space where your project files are stored.
• Submodule: A repository embedded within another repository.
• Commit: A snapshot of your repository at a specific point in time.
• Pull Request (PR): A request to merge your changes into another branch or repository.

By following this workflow, you can efficiently manage and collaborate on your SigiDoc project using Git.