Hello all

We have 2 kinds of "high-level" documentation (excluding the developer guide and the wiki for now):

  * The web site (source files: *.mdtext)
  * The maven site (source files: *.apt)

I guess that we need some consolidation. Is the following understanding right?

 * Many (most?) Apache projects do not use Maven web site as their main
   portal.
 * If the above is right, then Maven web site is accessible only on the
   Jenkins server [1].
 * According Apache policy, content of Jenkins server is for developers
   only.
 * Consequently, all current *.apt pages giving instruction to users
   shall move to *.mdtext files on the web site.
 * Conversely, the release-management page [2] currently on the web
   site could move to the Maven site.
 * Javadoc, currently on the Maven site, needs to be copied manually.
   But where?


The advantage of Maven *.apt files is that a search-and-replace in the source code includes those APT pages, which is very convenient for maintaining instructions that need to stay synchronized with the source code, while instructions that are considered stable can more easily be on the web site. Consequently, should I move the current "release-management.mdtext" file to a Maven APT file, before edition for the SIS specificities noticed in previous emails?


    Martin

[1] https://builds.apache.org/job/sis-trunk/site/
[2] http://sis.apache.org/release-management.html

Reply via email to