-
Notifications
You must be signed in to change notification settings - Fork 0
Migrating glossary terms
As explained in Make a glossary change and project phases, the first objective for migrating away from Google Drive is to recreate terms in the glossary terms register as repository issues. We'll work in the order of Dropped/pending terms first, then Target terms.
We want to start with Dropped/pending terms first so the debate history is recorded/established in the right place for future discussion. This should help prevent new collaborators from proposing the same terms again unnecessarily.
The suggested workflow:
- Go to the Glossary terms register.
- Move to the Dropped/pending terms sheet.
- For each term in the list (focusing on one at a time), check if there's a link under the Issue exists in GitHub? column. (If yes, skip to the next term and repeat.)
- If no link for a given term, start a new issue in GitHub using as follows:
- Give it a title using the convention
term: Term name, whereTerm nameis the actual term (e.g. term: Multichannel). - Add a comment in relation to any Reasons for dropping and Counter-arguments that may exist for the term in the terms register columns. (Include the names of people from who the reasons and arguments come from, if not yourself.)
- Click the "Labels" link at right of the issue comment box, and add one or more labels based on what's indicated under the Status column of the terms register, as follows: * If status is "term dropped", add the corresponding label. * If status is "term pending", add the corresponding label. * If status is "needs debate", add both the "needs debate" and "term pending" labels. * If status is blank, add both "term pending" and "needs debate" labels.
- Save the new issue.
Edit your comment if needed, and change labels if you made a mistake with them. No problem.
When issues exist for all Dropped/pending terms in the register, that sheet will be deleted from the register and these docs updated to reflect that workflow is done.
After the dropped/pending terms, focus should go to the Target terms, and particularly for definition draft files that have already been started.
The suggested workflow:
- Go to Glossary terms register.
- Move to the Target terms sheet, if not already there.
- For each term (one at a time), check if there's a link in the Issue column under Exists in GitHub repository?. (If yes, skip to the next term and repeat.)
- If no link, look in the Google Doc status column for any entry except "Blank". (Admins will take care of "Blank" terms.)
- For any entry beside "Blank", create a new issue for the term in GitHub as follows:
- Give it a title using the titling convention described earlier.
- As a comment, say something like, "Creating initial target term issue."
- Add these 2 labels: add to index and definition needs finished.
- Save the new issue.
Regarding step 4: repo administrators will create the necessary issues for "Blank" doc status terms, and add them in the working glossary index.
Regarding step 5.iii: if you are a collaborating editor, you can update the glossary index list yourself using the web interface editor. If you do this, remove the add to index label from the associated term issue.
Once terms migration is mostly wrapped up, then writers and editors can't start working on the real meat and potatoes — the draft definitions. Jump back to Make a glossary change for more on that direction.
README | Glossary index | Terms register (temporary)