cyverse-learning-materials/container-camp

CyVerse Container Camp workshop materials

container-camp's Issues

Improvements for topics/linux.rst Release spring-2021

This is a checklist issue for reviewing content within a specific RST.

1. Changes to be made to content

• Fix Icon image
• Fix Github Repo Url

2. Check on the following required formatting for all pages

• All .rst pages begin with the following

  .. include:: cyverse_rst_defined_substitutions.txt
  .. include:: custom_urls.txt
  
   |CyVerse_logo|_
  
  |Home_Icon|_
  `Learning Center Home <http://learning.cyverse.org/>`_
  

• 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 control

• Editor has checked for quality (spelling, formatting, etc.)
• Sample/test data is available with anonymous/public read access
  in the appropriate directory at /iplant/home/shared/cyverse_training

Create new rst file for docker-vice tie in Release spring 2021

This is a checklist issue for reviewing content within a specific RST.

1. Changes to be made to content

• tie in atmosphere build
• reference github with official dockerfiles for CyVerse VICE
• Explanation breakout for nginx & gomplate functionality
• Brief intro to ports on container
• App integration rst navgiation

2. Check on the following required formatting for all pages

• All .rst pages begin with the following

  .. include:: cyverse_rst_defined_substitutions.txt
  .. include:: custom_urls.txt
  
   |CyVerse_logo|_
  
  |Home_Icon|_
  `Learning Center Home <http://learning.cyverse.org/>`_
  

• 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 control

• Editor has checked for quality (spelling, formatting, etc.)
• Sample/test data is available with anonymous/public read access
  in the appropriate directory at /iplant/home/shared/cyverse_training

Improvements for docker/dockerintro.rst Release spring-2021

This is a checklist issue for reviewing content within a specific RST.

1. Changes to be made to content

• Move Contents mentioned in issue #8 to this rst file
• Fix Volumes image link
• Comment out Extra Demos Section

2. Check on the following required formatting for all pages

• All .rst pages begin with the following

  .. include:: cyverse_rst_defined_substitutions.txt
  .. include:: custom_urls.txt
  
   |CyVerse_logo|_
  
  |Home_Icon|_
  `Learning Center Home <http://learning.cyverse.org/>`_
  

• 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 control

• Editor has checked for quality (spelling, formatting, etc.)
• Sample/test data is available with anonymous/public read access
  in the appropriate directory at /iplant/home/shared/cyverse_training

Improvements for docker/findingcontainers.rst Release spring-2021

This is a checklist issue for reviewing content within a specific RST.

1. Changes to be made to content

• Fix CyVerse logo images
• Fix biocontainerlogo image
• Move all materials after NVIDIA GPU Cloud section to the Introduction to Docker RST file

2. Check on the following required formatting for all pages

• All .rst pages begin with the following

  .. include:: cyverse_rst_defined_substitutions.txt
  .. include:: custom_urls.txt
  
   |CyVerse_logo|_
  
  |Home_Icon|_
  `Learning Center Home <http://learning.cyverse.org/>`_
  

• 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 control

• Editor has checked for quality (spelling, formatting, etc.)
• Sample/test data is available with anonymous/public read access
  in the appropriate directory at /iplant/home/shared/cyverse_training

Improvements for topics/reproducibility.rst Release spring-2021

This is a checklist issue for reviewing content within a specific RST.

1. Changes to be made to content

• Fix Logo images
• Fix the sepectrum of practices image
• Fix Github repo Url

2. Check on the following required formatting for all pages

• All .rst pages begin with the following

  .. include:: cyverse_rst_defined_substitutions.txt
  .. include:: custom_urls.txt
  
   |CyVerse_logo|_
  
  |Home_Icon|_
  `Learning Center Home <http://learning.cyverse.org/>`_
  

• 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 control

• Editor has checked for quality (spelling, formatting, etc.)
• Sample/test data is available with anonymous/public read access
  in the appropriate directory at /iplant/home/shared/cyverse_training