Compendium of Cancer Genome Aberrations

Associate Editor Instructions

Revision as of 14:47, 12 June 2022 by Jennelleh (talk | contribs)

Instructions

  • IMPORTANT: On the Volunteer Assignments and Opportunities Page, Track Progress in Real Time of assigning author to pages (pending) and completion of pages (complete) as well as the date you reviewed the page and any notes of importance such as "non-WHO entity page" or check permissions for a figure. Open spaces in your area on this spreadsheet will alert the Editor-in-Chief to continue connecting potential authors with you. This is also the page to which potential new authors are directed to volunteer.
  • Onboarding Process:
  1. New authors will complete the Volunteer Form (if you're contacted directly please inform the new volunteer to complete this form).
  2. The Editor-in-Chief will email a link to the Volunteer Assignments and Opportunities page for volunteers to select which content to complete (which will indicate which Associate Editor will be involved).
  3. The Editor-in-Chief will email to introduce the Associate Editor and the new author (and mentor if applicable); this email will also include standardized onboarding information such as referring them to the Author Instructions. This email will be copied to the Technical Associate Editor, who will then create and send CCGA account credentials (username and password) directly to the new author.
  4. Once a page is assigned, ensure the author's name is IMMEDIATELY added both to the Volunteer Assignments and Opportunities page and to the top of the individual assigned page to clarity which pages are in progress.
  5. Ensure the page has the most current template and if not alert the Editor-in-Chief.
  6. If the author is a trainee, ensure they are working with a mentor or perform the mentor function if you're able to do so.
  7. Set up a reasonable due date for the author. For example, propose 4 weeks and if author agrees, send an Outlook invite for that due date that has a one week prior reminder prior to this deadline.
  • After authors indicate their page is complete, Perform Editorial Review:
  1. Review the content for accuracy and appropriate completeness.
  2. Prioritize use of the tables, including helping the author convert the content or doing so yourself if applicable. If a table is not needed based on current knowledge, leave it in but add the words "not applicable" and remove any "examples" text.
  3. Ensure the authors have inserted references in the standard format using the PubMed extension.
  4. Ensure the under construction note at the top of the page has been removed.
  5. Ensure appropriate and helpful images are included. Note: Amélie Giguère, Ph.D, FCCMG has offered to provide images for rare chromosomal translocations in hematological malignancies and most anomalies in WHO 2017.
  • After Complete Editorial Review:
  1. Approve the page using the FlaggedRevs system.
  2. Add page to your personal Watchlist so that you can be alerted when new alterations are made and need additional review.
  3. Add the editorial review completion date to the Volunteer Assignments and Opportunities page.
  4. Send an Email with the heading "Complete Page" and the page name or link in the text. This will alert the Editor-in-Chief and the Technical Associate Editor to perform additional tasks such as adding linking categories to the page.
  • Technical Issues:
  1. To resolve technical issues you or your authors encounter, fully describe the issue in an Email. Please include the title of the page on which the error occurred, a screenshot of the error message, the web browser you were using (i.e. firefox, google chrome, internet explorer, etc) and any other pertinent information. This will be received by our IT support and the Technical Associate Editor who will coordinate resolution of the issue in a timely manner.
  • For any applicable New Version of the WHO Classification of Tumours book:
  1. Collaborate with the Technical Associate Editor to move content or create new pages as needed.
  2. Solicit original page authors or help find new authors to update pages in a timely manner.
  3. Perform editorial review of the updated content.

Technical Associate Editor-Specific Functions

  • Onboarding Process:
  1. Following receipt of the Volunteer Form, assess appropriateness of volunteer and flag any concerns to the Editor-in-Chief (see "Policy for Granting of CCGA Contributor Access" section below). Transfer the information from the form into the Google tracking spreadsheet.
  2. Following receipt of the Editor-in-Chief email connecting the new author to the Associate Editor, assign credentials (username and password) to the new author (see "How to Create a New User Account" section below). IMPORTANT: Add the information to the User Access Log.
  • After Editorial Review Completed Process:
  1. Add Categories to the page to link searching functions on the homepage (see "How to Add Categories to a Page" section below).
  2. For any disease overview page that shows WHO classification structure, add the WHO copyright permission information in the Notes section at the bottom (last entry).
    • Since wiki-specific syntax is required for the embedded external link to function, copy the following information using the wiki syntax in the "Edit source" tab, and add it in the appropriate place near the bottom of the target page using the "Edit source" tab (make sure there's a space after the previous entry): *The hierarchical tumour classification structure displayed on this page is reproduced from the WHO Classification of Tumours with permission from the copyright holder, ©International Agency for Research on Cancer.
  3. Add the citation for the page in the Notes section at the bottom. For example: *Citation of this Page: Naeini Y, Quintero-Rivera F. “Myeloid Sarcoma”. Compendium of Cancer Genome Aberrations (CCGA), Cancer Genomics Consortium (CGC), updated 06/12/2022, https://www.ccga.io/index.php/Myeloid_Sarcoma. See this in action at the bottom of Example.
    • In order to have the updated section autopopulate on each page, you must use wiki-specific syntax. Therefore, copy this example from the "Edit source" tab and place it in the correct location on the target page using the "Edit" tab or manually type or paste in the yellow highlighted text below.
 
  • Page Conversion/Creation for New Versions of WHO Classification of Tumours Books:
  1. Help move content or create new pages as needed to support updating content structured according to the most current version of each WHO Classification of Tumours book.
  • Technical Issue Troubleshooting:
  1. Be a direct liaison with IT Support to resolve technical issues noted by the other Associate Editors and authors in a timely manner.
  • Streamlining and Automating Site:
  1. Help develop ideas for process improvement and automation of the CCGA site.
  2. Communicate the technical language for implementation of the improvements when possible.
  3. Provide technical review as processes are being developed and implemented.

How to Create a New User Account

  1. Sign into your personal CCGA account
  2. On left side of the homepage, click on “Special pages”
  3. Under the subheading Login/create account, click on “Create account”
  4. Fill out form such as the example below and click "Create account"
  5. As often the automatic email with a temporary password goes to junk mail, that option is not used. Instead, email the new user directly with their account credentials and let them know about the junk mail issue if they have to reset their password.
  6. IMPORTANT: Add the information to the User Access Log.
     

How to Add Categories to a Page

  1. At the bottom of each page, below the final Notes section, is a box with "Categories" in it. These represent links from the homepage's search options.
  2. To create Categories on a page that doesn't yet have any, log into your account and select the "Edit" tab at the top of the screen.
  3. Click on the hamburger icon on the upper right and select "Categories" from the drop down menu (see image below).
  4. In the box, add in categories appropriate to the page using the exact language of the options available here: All Categories.
  5. Save changes.
  6. Of note, if the page already has categories, they can be edited (deleted or added) in the same place by selecting the "Categories" from the hamburger icon's drop down menu.
 

Policy for Granting of CCGA Contributor Access

The Compendium of Cancer Genome Aberrations (CCGA) is a crowdsourced resource, with content created and modified in real time by users given a username and password.  This policy defines the process for determining new user access for creating and editing content.

  1. A member of the CCGA Knowledgebase workgroup or Genomic Resources Development Committee (GRDC) may provide access immediately if requested to do so by an individual.
  2. The person who provides access will add the new contributor information into the user access log at User Access Log.
  3. It is encouraged that ABMGG trainees, pathology residents or other post-graduate trainees collaborate with a mentor/sponsor who can help curate their work.
  4. Individuals will be required to review and agree with the “Honor Code for CCGA Content Contributor”.
  5. The GRDC reserves the right to deny CCGA site editorial access to any applicant and to remove access as deemed appropriate.
Retrieved from "https://ccga.io/index.php?title=Associate_Editor_Instructions&oldid=11386"