Skip to content

Triage for cyverse_tutorial_template Release 2.0 #7

@JasonJWilliamsNY

Description

@JasonJWilliamsNY

This is a checklist issue. As we review each repo we should check the following
items.

1. Check on file versions (all files below should have a version comment in the first line of the file)

  • misc/static/cyverse.css is version 2.0
  • misc/static/cyverse.js is version 2.0
  • misc/static/detail-expand.css is version 2.0
  • misc/static/intercom-script-for-learning.js is version 2.0
  • misc/static/question-answer.js is version 2.0
  • misc/static/jquery.min.js is version 2.0
  • misc/cyverse_spinx_conf.py is version 2.0
  • conf.py is version 2.0
  • cyverse_rst_defined_substitutions.txt is version 2.0
  • README.md is version 2.0

2. Check on the following required formatting for all pages

  • All .rst pages begin with the following

    .. include:: cyverse_rst_defined_substitutions.txt
    
     |CyVerse_logo|_
    
    |Home_Icon|_
    `Learning Center Home <http://learning.cyverse.org/>`_
    
  • Documentation contains maintainer info on index.rst or the appropriate
    first page

    Manual Maintainer(s)
    ------------------------
    
    Who to contact if this manual needs fixing. You can also email
    `[email protected] <[email protected]>`_
    
    .. list-table::
        :header-rows: 1
    
        * - Maintainer
          - Institution
          - Contact
       * - Your Name
          - CyVerse / UA
          - [email protected]
    
  • Documentation contains the fix/improve instructions on all .rst pages

    **Fix or improve this documentation**
    
    - Search for an answer:
       |CyVerse Learning Center|
    - Ask us for help:
      click |Intercom| on the lower right-hand side of the page
    - Report an issue or submit a change:
      |Github Repo Link|
    - Send feedback: `[email protected] <[email protected]>`_
    
  • All hyperlinks in documentation are on the repo's custom_urls.txt or cyverse_rst_defined_substitutions.txt
    Note: We want to avoid:

    • Best practice is to AVOID inline hyperlinks
    • Where possible links should NOT be on the .rst page but on a single
      document that is included. (e.g. custom_urls.txt or cyverse_rst_defined_substitutions.txt)
    • Links should have the form below and open in a new tab:
          .. |Link Title| raw:: html
      
         <a href="https://LINK.URL" target="blank">Link Title</a>
      
      
      

3. Overall quality

  • Maintainer is assigned and has approved the content
  • Editor has checked for quality (spelling, formatting, etc.)

Metadata

Metadata

Labels

2.0 ReleaseThis repo is a candidate for inclusion in the 2.0 Learning Center Release

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions