#51 Best place for docs?

3.1
closed-works-for-me
Fabian Keil
Research (4)
5
2013-02-16
2002-09-06
No

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?

Discussion

  • Hal Burgiss
    Hal Burgiss
    2002-09-07

    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?

     
  • David Schmidt
    David Schmidt
    2002-09-07

    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!

     
  • Fabian Keil
    Fabian Keil
    2013-02-16

    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.

     
  • Fabian Keil
    Fabian Keil
    2013-02-16

    • assigned_to: nobody --> fabiankeil
    • status: open --> closed-works-for-me