fix docs about docs.

Review Request #730 — Created July 24, 2014 and submitted

Larry Hosken
pants
385, 387
pants-reviews
areitz
I wanted to make sure a fix to 'goal markdown' didn't break 'goal confluence'.
So I had to get 'goal confluence' working. Along the way, figured out our
instructions were wrong, d'oh
published a couple of pages to a wiki.
  • 2
  • 0
  • 0
  • 0
  • 2
Description From Last Updated
I'd add something like, where ':confluence" is the name of your wiki() target Andy Reitz Andy Reitz
What is this URL? Is it an example? Andy Reitz Andy Reitz
Andy Reitz
  1. 
      
  2. src/python/pants/docs/page.rst (Diff revision 1)
     
     
    I'd add something like, where ':confluence" is the name of your wiki() target
  3. src/python/pants/docs/page.rst (Diff revision 1)
     
     
    What is this URL? Is it an example?
    1. better now?
    2. Looking pretty good. One minor thing is that there is one more reference to wiki.archie.org on line 123, before we explain that it's an example. Maybe move the example test up? Or leave it alone, because we explain it eventually?
      
      Or maybe we should just clean up this code so that we only require defining the URL once?
    3. added something further up; also left in a mention down below, in case folks look at those parts in isolation
      
      less repetition in our config would be good. might take a while, tho. figure we might as well fix up the docs for now
  4. 
      
Larry Hosken
Larry Hosken
Andy Reitz
  1. Looks good, thanks for iterating.
  2. 
      
Larry Hosken
  1. left a rant^W^W an issue cataloging the warts exposed here
    
    https://github.com/pantsbuild/pants/issues/395
  2. 
      
Larry Hosken
Review request changed

Status: Closed (submitted)

Loading...