samvera-labs / hydra_documentation_wg

Hydra Documentation Working Group - repo for tracking tickets and versioning artifacts of the working group.

Hydra Documentation Working Group

The Hydra Documentation Working Group contains most of the relevant details of the working group.

This repository is mainly for issue tracking, but may also include artifacts of the working group that we want to version and/or collaborate on with pull requests.

hydra_documentation_wg's Issues

Publish initial draft of the charter

Done when: initial draft of charter is published to Hydra Documentation Working Group page on the Duraspace wiki.

RENAME: Update CONTRIBUTING.md to match the maintenance template

The maintenance template for CONTRIBUTING.md is used by all Samvera repos. Replace the current version with the updated maintenance template version.

Announce WG call for proposal

Done when:

• CFP is announced on hydra-tech mailing list.
• CFP is announcedt on hydra-community mailing list.
• CFP announcement is added to agenda of next Hydra Tech call.
• Have someone with edit access to the Hydra Homepage on the Duraspace wiki add it to the list of active working groups.

RENAME: Recommendation for branch name testing - add CircleCI or update documentation

CircleCI can be used to prevent the recreation of the old default branch name. This helps preserve automatic redirection to the new default branch, and prevents accidentally re-adding the legacy branch from a stale fork. If CircleCI is not integrated with this repository, please do the following:

• Add information to the README explicitly defining branch naming conventions accepted for this repository (instructions in this GitHub gist).

• Optionally, integrate CircleCI with your repository (see GitHub documentation from CircleCI), and add a test to fail when a branch called master is present (instructions in this GitHub gist).

Rationale

Git's default "master" branch derives from "master/slave" jargon which perpetuates systemic racist language and systems (see email Replacing "master" reference in git branch names). To uphold our Code of Conduct, we must move away from the term "master" in our technical language (as well as words like blacklist or whitelist).

Related work

• Background on the renaming effort is available in the working group notes.
• See the GitHub Renaming documentation for the changes that GitHub made during the renaming process.

RENAME: Update references of hard-coded legacy master branch name to main branch name

Descriptive summary

This repository’s default branch has already been renamed using GitHub’s renaming tool. Links that reference the old branch name are automatically forwarded to the new default branch. But string references are not automatically updated.

Check this repository for hard-coded string references to the legacy “master” default branch and update them to the new default branch name “main.”

Important places to check include, but are not limited to:

• READMEs
• wikis
• other documentation

NOTE: READMEs, wikis, and other documentation are important to update to avoid confusion and correct errors in long lasting documentation.

Less common places to check:

• code
• Issues/PRs

NOTE: String references to themaster branch in Issues, PRs, and code are uncommon. Also Issues and PRs are temporal in nature, making it less critical to update those occurrences.

Rationale

Git's default "master" branch derives from "master/slave" jargon which perpetuates systemic racist language and systems (see email Replacing "master" reference in git branch names). To uphold our Code of Conduct, we must move away from the term "master" in our technical language (as well as words like blacklist or whitelist).

Related work

• Background on the renaming effort is available in the working group notes.
• See the GitHub Renaming documentation for the changes that GitHub made during the renaming process.

Approve WG charter

Done when: working group charter is approved.

RENAME: Add language to README about branch naming

Add the following branch renaming language to the README for this repository.

## Contributing 

If you're working on PR for this project, create a feature branch off of `main`. 

This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and [language recommendations](https://github.com/samvera/maintenance/blob/master/templates/CONTRIBUTING.md#language).  Please ***do not*** create a branch called `master` for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.

Rationale

Git's default "master" branch derives from "master/slave" jargon which perpetuates systemic racist language and systems (see email Replacing "master" reference in git branch names). To uphold our Code of Conduct, we must move away from the term "master" in our technical language (as well as words like blacklist or whitelist).

Related work

• Background on the renaming effort is available in the working group notes.
• See the GitHub Renaming documentation for the changes that GitHub made during the renaming process.

Rename master branch to main

The Renaming Branch Working Group is in the process of renaming the default branch from master to main in Samvera and Samvera-Labs repos. This brings repositories into compliance with the Samvera Community Code of Conduct (https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and language recommendations (https://github.com/samvera/maintenance/blob/master/templates/CONTRIBUTING.md#language).

This issue will be complete when the master has been renamed to main.

Related issues will have a title beginning with RENAME.

Use Doodle poll to agree upon recurring meeting time for WG

Done when:

• Doodle poll is created for selecting a meeting time.
• All working group members fill out the poll.
• WG wiki page is updated with the agreed upon time.