Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: docs
    • Security Level: Public
    • Labels:

      Description

      It may have been an artifact of the order in which docs were integrated, but I don't see release notes in the right place in the current document.

      http://www.couchbase.com/docs/couchbase-sdk-ruby-1.3/couchbase-sdk-ruby-rn.html

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Hide
        kzeller kzeller added a comment -

        Hi,

        So I investigated this last night and discovered all the XML and content are intact and valid for this entire document.

        When I generate PDF the content is missing as well as when the XML to HTML conversion happens. I think this is something to do with the Perl parser that does our conversions expecting some setting.

        Can you please get someone familiar with Perl to look at this conversion script?

        Thanks,

        Karen

        Show
        kzeller kzeller added a comment - Hi, So I investigated this last night and discovered all the XML and content are intact and valid for this entire document. When I generate PDF the content is missing as well as when the XML to HTML conversion happens. I think this is something to do with the Perl parser that does our conversions expecting some setting. Can you please get someone familiar with Perl to look at this conversion script? Thanks, Karen
        Hide
        wayne Wayne Siu added a comment -

        Matt, can you or someone on your team help? Thanks.

        Show
        wayne Wayne Siu added a comment - Matt, can you or someone on your team help? Thanks.
        Hide
        ingenthr Matt Ingenthron added a comment -

        Mark: I know you haven't been in here before, but can you possibly work with Wayne/Karen to help us out to try to fix this? There's some scripting forensics required.

        Show
        ingenthr Matt Ingenthron added a comment - Mark: I know you haven't been in here before, but can you possibly work with Wayne/Karen to help us out to try to fix this? There's some scripting forensics required.
        Hide
        mnunberg Mark Nunberg added a comment -

        If you can show me the toolchain or give me access to a remote machine (probably the best) where this toolchain is installed, I could help dig into the issue.

        Show
        mnunberg Mark Nunberg added a comment - If you can show me the toolchain or give me access to a remote machine (probably the best) where this toolchain is installed, I could help dig into the issue.
        Hide
        kzeller kzeller added a comment -

        Here is the toolchain information:

        =======

        This is the info you wanted for RCBC-128 on the Toolchain for publishing. I set up 1.3 guides and they generate as PDF and HTML but somehow the release notes are not being pulled in during conversion.

        There are no failure messages on the server or on my local machine when the build runs, and the XML is clean. You basically just get a blank page in PDF and HTML for the release notes.

        The new ruby guide is here, set up according to what Matt/Sergey agreed on content:

        https://github.com/couchbase/docs/tree/master/Couchbase/products/couchbase/couchbase-sdk-ruby-1.3

        For the release notes, there is XML typically in every guide that seems to serve as an include statement here:

        https://github.com/couchbase/docs/blob/master/Couchbase/products/couchbase/couchbase-sdk-ruby-1.3/releasenotes-metasrc.xml

        The XML=>HTML conversion runs here: ssh jenkins@ubu-1701.hq.couchbase.com, you can use Qakey.pem to access it

        In ~/docs we recreated a shell script that will Git pull the current docs repo
        Then it will do a make publish-push to trigger the XML=>HTML conversion

        This make task runs a bunch of Perl scripts that do the conversion as well as includes. I believe all the Perl scripts called by make are under the Publish Then the make task syncs the new HTML with our web server.

        Let me know if you need the key for access to this machine, but you should have it as it is the QA key for jenkins.

        Regards,

        Karen

        Show
        kzeller kzeller added a comment - Here is the toolchain information: ======= This is the info you wanted for RCBC-128 on the Toolchain for publishing. I set up 1.3 guides and they generate as PDF and HTML but somehow the release notes are not being pulled in during conversion. There are no failure messages on the server or on my local machine when the build runs, and the XML is clean. You basically just get a blank page in PDF and HTML for the release notes. The new ruby guide is here, set up according to what Matt/Sergey agreed on content: https://github.com/couchbase/docs/tree/master/Couchbase/products/couchbase/couchbase-sdk-ruby-1.3 For the release notes, there is XML typically in every guide that seems to serve as an include statement here: https://github.com/couchbase/docs/blob/master/Couchbase/products/couchbase/couchbase-sdk-ruby-1.3/releasenotes-metasrc.xml The XML=>HTML conversion runs here: ssh jenkins@ubu-1701.hq.couchbase.com, you can use Qakey.pem to access it In ~/docs we recreated a shell script that will Git pull the current docs repo Then it will do a make publish-push to trigger the XML=>HTML conversion This make task runs a bunch of Perl scripts that do the conversion as well as includes. I believe all the Perl scripts called by make are under the Publish Then the make task syncs the new HTML with our web server. Let me know if you need the key for access to this machine, but you should have it as it is the QA key for jenkins. Regards, Karen
        Hide
        kzeller kzeller added a comment -

        I discovered the problem while I was setting up the C library. Inconsistent version label between the release note file "1.3.0" and the build files:

        http://www.couchbase.com/docs/couchbase-sdk-ruby-1.3/couchbase-sdk-ruby-rn_1-3-0.html

        Show
        kzeller kzeller added a comment - I discovered the problem while I was setting up the C library. Inconsistent version label between the release note file "1.3.0" and the build files: http://www.couchbase.com/docs/couchbase-sdk-ruby-1.3/couchbase-sdk-ruby-rn_1-3-0.html
        Hide
        kzeller kzeller added a comment -

        I discovered the problem while I was setting up the C library. Inconsistent version label between the release note file "1.3.0" and the build files:

        http://www.couchbase.com/docs/couchbase-sdk-ruby-1.3/couchbase-sdk-ruby-rn_1-3-0.html

        Show
        kzeller kzeller added a comment - I discovered the problem while I was setting up the C library. Inconsistent version label between the release note file "1.3.0" and the build files: http://www.couchbase.com/docs/couchbase-sdk-ruby-1.3/couchbase-sdk-ruby-rn_1-3-0.html

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            ingenthr Matt Ingenthron
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes