Added manual documentation for updating and reviewing file attachments

Review Request #6801 — Created Jan. 17, 2015 and submitted

Information

Review Board
master
20f0351...

Reviewers

Added an initial png for the docs "file-revision-selector.png" that demonstrates the attachment slider for the user.
Also added docs for the image and text diffing in file attachments, features that were exposed by the attachment slider.

Spellcheck


Description From Last Updated

This either should be broken down into sub-steps or not use enumeration, because there is only one step.

brenniebrennie

Lines in reST should be < 80 characters.

brenniebrennie
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
    
    
  2. 
      
RM
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
        docs/manual/users/reviews/reviewing-text-files.rst
        docs/manual/users/reviews/reviewing-markdown.rst
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-images.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
        docs/manual/users/reviews/reviewing-text-files.rst
        docs/manual/users/reviews/reviewing-markdown.rst
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-images.rst
    
    
  2. 
      
RM
reviewbot
  1. Tool: Pyflakes
    Ignored Files:
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
        docs/manual/users/reviews/reviewing-text-files.rst
        docs/manual/users/reviews/reviewing-markdown.rst
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-images.rst
    
    
    
    Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
        docs/manual/users/reviews/reviewing-text-files.rst
        docs/manual/users/reviews/reviewing-markdown.rst
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-images.rst
    
    
  2. 
      
RM
brennie
  1. Minor nitpicks.

  2. Show all issues

    This either should be broken down into sub-steps or not use enumeration, because there is only one step.

  3. Show all issues

    Lines in reST should be < 80 characters.

  4. 
      
RM
reviewbot
  1. Tool: PEP8 Style Checker
    Ignored Files:
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
        docs/manual/users/reviews/reviewing-text-files.rst
        docs/manual/users/reviews/reviewing-markdown.rst
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-images.rst
    
    
    
    Tool: Pyflakes
    Ignored Files:
        docs/manual/users/reviews/reviewing-files.rst
        docs/manual/users/review-requests/uploading-files.rst
        docs/manual/users/reviews/reviewing-text-files.rst
        docs/manual/users/reviews/reviewing-markdown.rst
        docs/manual/users/reviews/file-revision-selector.png
        docs/manual/users/reviews/reviewing-images.rst
    
    
  2. 
      
david
  1. I'm going to make some minor changes to the spacing (two blank lines before each markdown section), but otherwise this looks great. Thanks!

  2. 
      
RM
Review request changed
Status:
Completed
Change Summary:
Pushed to master (22021c1)