Project

General

Profile

Forums » Help »

How to integrate daily-built documentation into one's project

Added by Matěj Týč about 14 years ago

Hello,
I understand that there is the "documents" property of a project that is intended for publishing the project's documentation.
However, there are some aspects that any documentation is quite likely to have.
First of all, imagine that you are able to generate the documentation in the HTML format. It makes sense to view it in the project's section "semlessly", like in a frame.
And second of all, imagine that the documentation gets periodically rebuilt because users constantly add elements to it. Although this is more specific to projects in the beginning phase, it is not very practical to upload new versions of documentation by hand using the provided GUI.

So what do you think? There is probably an answer to the second question that could go into the Redmine documentation and concerning the first question's topic, is it good enough for a ticket?


Replies (3)

RE: How to integrate daily-built documentation into one's project - Added by Glenn Gould about 14 years ago

Maybe you'd want to have a look at the Embedded-plugin from JPL himself.

However, the plugin misses an upload mechanism from within redmine, you need to setup a mechanism that moves the autogenerated documentation to the target folder with operating systems tools.

RE: How to integrate daily-built documentation into one's project - Added by Stefan H Singer about 14 years ago

Is this for internal documentation or is it like... Consumer documentation for a product that will ship?

If the former, couldn't you use the Wiki? Then the documentation would also be searchable.

RE: How to integrate daily-built documentation into one's project - Added by Matěj Týč about 14 years ago

Wow, thank you, the plugin is really great, and it still has quite a lot of potential.

Anyway, having the documentation in a metaformat is good for you, since you can generate HTML, PDF etc. as you like. The wiki format itself is not very flexible, although it is very useful for documenting the volatile stuff.

    (1-3/3)