Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-6416095

Change docs structures to support efficient work processes

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Fixed
    • P3
    • 6
    • 6
    • docs
    • None
    • b83
    • generic
    • generic

    Description

      To support efficient workflow, we need to produce a document structure that separates generated documents from edited ones, just as classes are separated from source files, and generated sources from edited sources. The target structure will look like this:

                                    javase
                                      |
                                      6
           ___________________________|
          | |
       webnotes docs
          | ________ _____|___ ______ _______ ____
          | | | | | | |
       install technotes legal : api platform jre jdk
                _______|_______ : | | |
               | | | : | api api
            tools samples guides : _____|_____ _____
                                      : | | | |
                                      : jvmti jdwp rmi serialization
                                      :

      where the api/ and platform/ directories contain normative generated specs, while jre and jdk contain informative generated specs.

      Here is what the direcotories will contain:

         docs/api: Java SE apis. (Same as current docs/api)

         webnotes (web only pages)
         ------------------------
         --files that were on the web and in relnotes
         --most recently: devdocs-vs-specs.html

         legal (from old relnotes)
         -------------------------
         license.html
         SMICopyright.html
         prop_rights.html

      samples (old relnotes)
         ---------------------
         demos.html
         javaws_samples.html (old samples.html)

      Note: contacts.html goes away

         platform/jvmti
         --------------
         jvmti.html


         platform/jdwp
         --------------
         jdwp-protocol.html


         platform/rmi
         ---------
         *.html
         .pdf

      platform/serialization
         -------------------
         *.html
         .pdf

      jre/api:
         -------
         attach/spec
         javaws/jnlp
         jpda/jdi
         management/extension
         net/httpserver/spec
         plugin/dom
         security/jass/spec
         security/jgss/spec
         security/smartcardio/spec

         jdk/api:
         -------
         apt/mirror
         javadoc/doclet
         javadoc/taglet

         tools (old "tooldocs"):
         ----------------------
         share/ solaris/ linux/ windows/

         technotes (old "guides")
         ------------------------
         2d/ javadoc/ pack200/
         access/ javaws/ performance/
         apt/ jdbc/ plugin/
         attach/ jmx/ preferences/
         awt/ jndi/ reflection/
         beans/ jni/ refobs/
         collections/ jpda/ rmi/
         concurrency/ jps/ rmi-iiop/
         deployment/ jvmti/ security/
         dragndrop/ lang/ serialization/
         extensions/ language/ sound/
         idl/ logging/ standards/
         imageio/ management/ swing/
         imf/ math/ versioning/
         intl/ net/ vm/
         io/ nio/ xml/
         jar/
      Left out of the original picture:

                  _EDITED_ _GENERATED_
                                    javase
                                      |
              (things to the left) 6 (things to the right)
           ___________________________|
          | |
       webnotes docs
                                      .
                                      .
                                      .

      Attachments

        Issue Links

          Activity

            People

              earmstrosunw Eric Armstrong (Inactive)
              earmstrosunw Eric Armstrong (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: