On 08/26/10 - 05:00:21PM, Jason Guiditta wrote:
> On Thu, 2010-08-26 at 14:56 -0400, Chris Lalancette wrote:
> > All documentation should now be in the docs directory anyway.
> > 
> > Signed-off-by: Chris Lalancette <[email protected]>
> > ---
> >  README |  150 
> > ----------------------------------------------------------------
> >  1 files changed, 0 insertions(+), 150 deletions(-)
> >  delete mode 100644 README
> > 
> 
> ACK, however this brings up something I have been thinking about, wanted
> to see what others thought.
> 
> I wonder if removing things like this from the specific repos might not
> be the way to go long term.  It seems to me, that as we start to have
> more components working together (condor, image factory/warehouse, etc),
> it might remain useful for someone to be able to clone one of these
> repos and get the relevant docs for them.  The point of moving things
> into the dcos repo was to make a central location to build the site
> from, but it was just aggregator and api when we did that - now things
> are a bit more distributed.
> 
> I talked to Jim Meyering, and one of his suggestions was to have our
> build script for the site grab whatever files we want to include up
> there from other repos, but let those projects be the authority on what
> is in there.  So the script could, for example, wget the latest README
> for condor for its repo, and wrap that in some navigation, etc.  But if
> you clone condor repo directly, you still get the docs you need.
> 
> Any strong opinions either way?

Yeah, I totally agree with you here.  It is much nicer to digest the whole
thing piece by piece, rather than having to wade in from the top-level.
However, this file is very misleading, so I thought it best to wipe the slate
clean, and then start over.  That way new people won't be led off into old
code.

Let's remove this file, and then work on a better aggregator README that more
reflects the current state of the world.

-- 
Chris Lalancette
_______________________________________________
deltacloud-devel mailing list
[email protected]
https://fedorahosted.org/mailman/listinfo/deltacloud-devel

Reply via email to