**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: `Tutorials@CyVerse.org <Tutorials@CyVerse.org>`_
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.cssis version 2.0misc/static/cyverse.jsis version 2.0misc/static/detail-expand.cssis version 2.0misc/static/detail-expand.jsis version 2.0misc/static/intercom-script-for-learning.jsis version 2.0misc/static/question-answer.jsis version 2.0misc/static/jquery.tablesorter.min.jsis version 2.0misc/cyverse_spinx_conf.pyis version 2.0conf.pyis version 2.0 and you have updated the name of the documentation (check the project =' line, yourindex.rstshould havethe appropriate name)
cyverse_rst_defined_substitutions.txtis version 2.0License.mdis version 2.02. Check on the following required formatting for all pages
All
.rstpages begin with the followingDocumentation contains maintainer info on
index.rstor the appropriatefirst page. This should be placed directly before the table of contents.
Documentation contains the fix/improve instructions on all
.rstpagesAll hyperlinks in documentation are on the repo's
custom_urls.txtorcyverse_rst_defined_substitutions.txtNote: We want to avoid:
.rstpage but on a singledocument that is included. (e.g.
custom_urls.txtorcyverse_rst_defined_substitutions.txt)custom_urls.txtshould be for URLS specific to that repocyverse_rst_defined_substitutions.txtis a list of generic links toother CyVerse and Learning Center pages
Check the |Github Repo Link| on each .rst page and ensure it links to the correct GitHub repository for this documentation.
3. Overall quality
in the appropriate directory at
/iplant/home/shared/cyverse_training