[ ijbswa-Developer TODOs-605568 ] Best place for docs?

Developer TODOs item #605568, was opened at 2002-09-06 06:42
Message generated for change (Comment added) made by fabiankeil
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=400339&aid=605568&group_id=11118

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Research
Group: 3.1
>Status: Closed
>Resolution: Works For Me
Priority: 5
Private: No
Submitted By: Andreas Oesterhelt (oes)
>Assigned to: Fabian Keil (fabiankeil)
Summary: Best place for docs?

Initial Comment:
Two questions, loosely related:

A) Get rid of generated docs in CVS -- To where and how?

Should we rm them from the trunk and modify the
dok target to download the docs from privoxy.org
in the absence of the required build tools or doc
sources?
Maybe extend to all non-source non-script doc files, i.e.
keep team pictures etc only on webserver?

B) Split docs into own CVS module?

Ist that still necessary if we do A)? Benefit? If we
do, move the doc build tools from utils with them?

Thoughts? Experiences from other projects?


----------------------------------------------------------------------

>Comment By: Fabian Keil (fabiankeil)
Date: 2013-02-16 04:37

Message:
I don't see a problem with having the generated documentation in CVS,
especially now that we no longer have "binary documentation" (PDF) and
given that the documentation system doesn't work cross-platform.

----------------------------------------------------------------------

Comment By: David Schmidt (david__schmidt)
Date: 2002-09-06 18:27

Message:
Logged In: YES 
user_id=249980

I like the idea of users and packagers able to download them
from the files section.  What a concept... docs available
[shortly] before a package!  Revolutionary!

----------------------------------------------------------------------

Comment By: Hal Burgiss (hal9)
Date: 2002-09-06 17:24

Message:
Logged In: YES 
user_id=322640

Andreas, I agree generated docs should not be in cvs. It
causes trouble with merge conflicts. I think either posted
on website, prdownloads (ftp), or the Files section since
users may want to get them to. 

I would like to see the sgml sources stay in the 'current'
module. This makes building README and similar files easier
since they can just be outputted directly into the source tree. 

I'd also like to KISS, so the packagers don't have to jump
through hoops to bundle them. 

FTP?

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=400339&aid=605568&group_id=11118

------------------------------------------------------------------------------
The Go Parallel Website, sponsored by Intel - in partnership with Geeknet, 
is your hub for all things parallel software development, from weekly thought 
leadership blogs to news, videos, case studies, tutorials, tech docs, 
whitepapers, evaluation guides, and opinion stories. Check out the most 
recent posts - join the conversation now. http://goparallel.sourceforge.net/