Workflow

This page describes the actions necessary to modify an existing document and keep it in sync with other contributions to the document as well as updates to central ELISA styles / bibliographic references / graphics.

Prerequisites

ELISA white papers are published under the Creative Commons Attribution-ShareAlike 4.0 license (see White Papers License. For details about the license, refer to About The Licenses - Creative Commons. You must contribute your work according to this license.

Your work must be signed.

Contributing Work (Document Team)

• Make changes to the document on your machine. Refer to the Tips and Tricks page for guidance on structuring your work.
• Commit your work periodically. You must at least commit your work before you push it to the document repository.
  • Use the command: git commit --all --signoff
  • A text editor window will appear with a commit message template and a signoff message with your e-mail address. Refer to How to Write a Git Commit Message for an explanation of the commit message structure and recommendations about formulating your commit message.
  • Git uses vi as its default editor. If you don't know how to to use vi or don't want to, refer to Associating text editors with Git - Git Help to change the default to your preferred editor.
  • The commit is finished when you close the editor window.
• When you're ready to push, merge your changes with the document repository. Refer to
  • Syncing your branch - GitHub Help
  • Resolving a merge conflict using the command line - GitHub Help
• Push the changes to the document repository.

Syncing / Publishing The Document (Principal Author)

• When you're ready to make the document visible to the general ELISA community, merge the document repository with the elisa-tech repository.
  Refer to
  • Syncing a fork - GitHub Help
  • Resolving a merge conflict using the command line - GitHub Help.
• Create a pull request. Refer to About pull requests - GitHub Help.

Reviewing

tbd