Update a bunch of stuff in the docs.

 






 

 


  Review Request #4981
  —
  Created Nov. 17, 2013 and submitted 

 


















 

  

   Information

  





 
 

  david
 









 
 

  Review Board
 









 
 

  master
 









 
 

  
 









 
 

  
 






 




 

  

   Reviewers

  





 
 

  reviewboard
 









 
 

  
 






 








 





  


 
 

  
Update a bunch of stuff in the docs.


I just did a read-through of the docs to check for things that are out of date.

Aside from having to completely rewrite the 'post-review' page, and many of our

screenshots being old and out of date, there were a few text changes that

needed to be made:


    

  • The reference to "Getting Started" in the codebase "Custom Forks" page wasn't
    
  correct.
    • 

  • The "Unit Tests Fixtures" page still listed test_reviewrequests and didn't
    
  have any information about the new TestCase class.
    • 

  • The minimum browser versions still said we supported IE7.
    • 

  • The "What is Code Review" page had out of date information about the state of
    
  our support for post-commit review.
    • 

  • There was a typo in the paragraph about the "Bugs" field.
    • 

  • There was no documentation for the "Depends On" field.
    • 


 








  


 
 

  
Built user manual and codebase html and looked at the results.

 







 









 





  








 






 
 
 

  

   

    

     
    

    
    
     
  • 
      
     
    • 
     
  • 
      
     
    • 
     
  • 
      
     
    • 
     
  • 
      
     
    • 
     
  • 
      
     
    • 
    

   

   

    
     

      Description
      From
      Last Updated
     

    
    



     

      
       
       
Don't we want to advertise rbt post now? Also, might be nice to have the post-commit part as a separate …

      		
      
       chipx86chipx86
      
      
       
      
     


    
   

  

 







 






  

 








 














 





 

  

   




chipx86




   

   







  

 



 

  


   

   

    
 
chipx86


    
   


  

  

  



    




  1. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 

















  2. 
 
    
  
  
    
  
 

   
    
    
    




    
 
    
  
  
  

  
  
   Show all issues
  
 
    

    



    
    Don't we want to advertise rbt post now?
    

    Also, might be nice to have the post-commit part as a separate paragraph, for scanability.
    
  
    
 
    

 
    
  


    
 
    
 
      

  


    1. 
 
 
      
 
      
  
 
      
 
      
  
      We don't have any docs for rbt right now in the manual. I'm working on that, but it's a much larger change.
      
 
      

      2. 



    2. 
 
 
      
 
      
  
 
      
 
      
  
      We have RBTools docs though.
      
 
      

      3. 



    3. 
 
 
      
 
      
  
 
      
 
      
  
      Did we even have post-review docs anymore in the RB manual? I guess I'm confused.
      
 
      

      4. 



    4. 
 
 
      
 
      
  
 
      
 
      
  
      Yes, we do: http://www.reviewboard.org/docs/manual/dev/users/tools/post-review/
      

      I looked at the rbtools docs and didn't immediately find any of the stuff on actually using rbt or post-review, since the structure hides it a lot (you have to click one of a few small links and then bam! big doc). I'll think about how to improve that, but in the mean-time, how do I cross reference across docsets?
      
 
      

      5. 



    5. 
 
 
      
 
      
  
 
      
 
      
  
      Add http://www.reviewboard.org/docs/rbtools/dev/ to intersphinx_mapping in conf.py. It should then let you reference anything in that manual.
      
 
      

      6. 



    6. 
 
 
      
 
      
  
 
      
 
      
  
      Yeah, I figured that out. See my later change that fixes the post-review references up.
      
 
      

      7. 


 
    


    

 
    

    3. 




  3. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    4. 




  

 
















 



 

  

   




david




   

   

  

 



 















 





 

  

   




chipx86




   

   







  

 



 

  


   

   

    
 
chipx86


    
   


  

  

  



    




  1. 
 
    
  
    
   
    Ship It!
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    2. 















  2. 
 
    
  
    
   
    
  
    
 
    

 
    
  


    
 
    
 
      

  

 
    


    

 
    

    3. 




  

 
















 



 

  

   




david




   

   

  

 



 

  


   

   

    
 Review request changed

    
   


  

  

  






 

  Status:
  

  Closed (submitted)

  
 




 
Change Summary:

 
Pushed to master (78a28ed)





 


 










  

 









     

    

   

  

  

   
   Loading...