How to Use Github for Arctos
Stable link to this page: http://dx.doi.org/10.7299/X75B02M5
Why Use GitHub for Arctos?
-
GitHub hosts Arctos Documentation and How-to Guides, which are published as the Arctos Handbook. These will help you function as an Arctos user or operator.
-
If you have an Arctos Issue, post it on the Issues site. There you can also view and comment on open issues.
-
Guide to How to Use Issues in Arctos
-
Developers who are interested in Arctos code can view it in the ArctosDB/arctos and ArctosDB/DDL repositories.
How to Get Started in GitHub
-
Set up a new (and free) account in GitHub. Go to http://github.com and fill out the form with a username, email address, and password. Your username will be your screen name. Your email address will be used to send notifications.
-
Click the big green button to "Sign up for GitHub."
What You Can Do in GitHub
-
Anyone can view, post, or comment on an Issue (https://github.com/ArctosDB/arctos/issues). You do not need special permissions to do this. Without special permissions, however, you cannot label an issue, close an issue, assign an issue to another person, or assign a milestone to an issue.
-
Curators/Collection Managers may request permission to become a member of the "Users" team in order to create and/or edit Documentation and How-to Guides. To become a member of this team, send an email with your GitHub username to [email protected] and [email protected].
-
Only people with administrative permissions can add new members. To do that, go to https://github.com/ArctosDB and click on "Invite someone" at the bottom of the People pane on the right of the window. Search by the person's GitHub username and enter it where prompted. Select the person to add. He/she will need to accept the membership invitation in order to become a member. When you invite someone, the default role is 'member' versus 'owner' which has more administrative privileges.
-
Members who are assigned to the 'Users' team have access to the documentation wiki where they can create and edit Documentation and How-to Guides. They cannot invite other members, however, without additional administrative privileges.
-
If you want to receive notifications (e.g., data issues) from VertNet, your GitHub account needs to be added to the VertNet repository for your collection. For more information, read the VertNet Guide to Issue Tracking.
TIP: Documentation pages are written in Markdown, which is dead simple to learn. Here's a cheatsheet