ZooKeeper
  1. ZooKeeper
  2. ZOOKEEPER-181

Some Source Forge Documents did not get moved over: javaExample, zookeeperTutorial, zookeeperInternals

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 3.0.0
    • Fix Version/s: 3.0.0
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      Some Source Forge Documents did not get moved over:

      javaExample
      zookeeperTutorial
      (These two I will move over directly)

      zookeeperLogging
      zookeeperAtomicBroadcast
      (These two I will roll up into a new document: zookeeperInternals)

      We can expand zookeeperInterals as new sections are needed, maybe one day morphing it into the "complete guide for zookeeper contributers"

      1. ZOOKEEPER_181.patch
        74 kB
        Robbie Scott
      2. 2pc.png
        14 kB
        Robbie Scott
      3. ZOOKEEPER_181.patch
        74 kB
        Patrick Hunt

        Issue Links

          Activity

          Hide
          Robbie Scott added a comment -

          This patch has the content mentioned in the JIRA, plus supporting sample code files:
          DataMonitor.java (for the java example)
          Executor.java (for the java example)
          SyncPrimitive.java (for the tutorial)

          I put all the sample Java source into resources/images only because the build system creates the links to them from the output html correctly. There might be a better place, if anyone is familiar with the build system.

          Also, this patch contains an image file
          2pc.png

          site.xml and index.xml contain updates so that they point to the new files.

          There is a change in skinconf.xml to beautify program listings.

          Finally, some changes to zookeeperAdmin.xml, since one of the sections from the source forge zookeeperLogging content is actually more appropriate for an admins guide than for an internals guide.

          Show
          Robbie Scott added a comment - This patch has the content mentioned in the JIRA, plus supporting sample code files: DataMonitor.java (for the java example) Executor.java (for the java example) SyncPrimitive.java (for the tutorial) I put all the sample Java source into resources/images only because the build system creates the links to them from the output html correctly. There might be a better place, if anyone is familiar with the build system. Also, this patch contains an image file 2pc.png site.xml and index.xml contain updates so that they point to the new files. There is a change in skinconf.xml to beautify program listings. Finally, some changes to zookeeperAdmin.xml, since one of the sections from the source forge zookeeperLogging content is actually more appropriate for an admins guide than for an internals guide.
          Hide
          Patrick Hunt added a comment -

          It would be great if we could inline the src examples rather than pointing to resources/images.

          Also the patch fails to validate when running forrest.

          [exec] /home/phunt/dev/workspace/gitzk_svn/src/docs/src/documentation/content/xdocs/javaExample.xml:81:24: The content of element type "para" must match "(footnoteref|xref|abbrev|acronym|citetitle|emphasis|footnote|phrase|quote|trademark|link|ulink|command|computeroutput|email|filename|literal|option|replaceable|systemitem|userinput|inlinemediaobject)".

          Show
          Patrick Hunt added a comment - It would be great if we could inline the src examples rather than pointing to resources/images. Also the patch fails to validate when running forrest. [exec] /home/phunt/dev/workspace/gitzk_svn/src/docs/src/documentation/content/xdocs/javaExample.xml:81:24: The content of element type "para" must match "(footnoteref|xref|abbrev|acronym|citetitle|emphasis|footnote|phrase|quote|trademark|link|ulink|command|computeroutput|email|filename|literal|option|replaceable|systemitem|userinput|inlinemediaobject)".
          Hide
          Robbie Scott added a comment -

          This patch fixes the above problems:

          -inlines the example source code
          -vailidates correctly

          Also, this patch catches in its net a couple of instances of converting computerout sdoc tags to programlisting tags

          Show
          Robbie Scott added a comment - This patch fixes the above problems: -inlines the example source code -vailidates correctly Also, this patch catches in its net a couple of instances of converting computerout sdoc tags to programlisting tags
          Hide
          Robbie Scott added a comment -

          this goes here
          zookeeper_trunk/src/docs/src/documentation/resources/images/2pc.png

          Show
          Robbie Scott added a comment - this goes here zookeeper_trunk/src/docs/src/documentation/resources/images/2pc.png
          Hide
          Patrick Hunt added a comment -

          there are some link issues that are causing the pdf generation to fail. cancelling patch.

          Show
          Patrick Hunt added a comment - there are some link issues that are causing the pdf generation to fail. cancelling patch.
          Hide
          Patrick Hunt added a comment -

          Updated with some minor formatting changes.

          Show
          Patrick Hunt added a comment - Updated with some minor formatting changes.
          Hide
          Patrick Hunt added a comment -

          Committed revision 703480.

          Show
          Patrick Hunt added a comment - Committed revision 703480.
          Hide
          Patrick Hunt added a comment -

          3.0.0 has been released, closing issues.

          Show
          Patrick Hunt added a comment - 3.0.0 has been released, closing issues.

            People

            • Assignee:
              Patrick Hunt
              Reporter:
              Robbie Scott
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 48h
                48h
                Remaining:
                Remaining Estimate - 48h
                48h
                Logged:
                Time Spent - Not Specified
                Not Specified

                  Development