JBehave
  1. JBehave
  2. JBEHAVE-994

Allow import to filesystem from Confluence

    Details

    • Type: Improvement Improvement
    • Status: Resolved Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.9.1
    • Component/s: REST Support
    • Labels:
      None
    • Patch Submitted:
      Yes
    • Number of attachments :
      2

      Description

      We keep our story descriptions in Confluence and it would be nice to be able to import them to filesystem similarly to what is done for Redmine and XWiki.

      There's currently a basic REST interface for newer Confluence versions which can be used to access content. Also the rich text editor adds quite some noise to the page content, which we have to deal with. We propose following conventions for an import:

      • Import starts at a given root page and looks into all the child pages traversable from there. The root page is entered as the browser navigates to it (/display/space/pagename)
      • JBehave Story relevant parts are kept in containers. For a start we can use panel and info.
      • A table in the page is considered as example table.

      Attached are some samples how this looks in Confluence.

      Pull request will follow.

        Activity

        Mauro Talevi made changes -
        Field Original Value New Value
        Component/s Maven Plugin [ 12482 ]
        Summary Export Stories from Confluence Add support for Confluence as REST provider
        Mauro Talevi made changes -
        Fix Version/s 3.9.1 [ 19830 ]
        Mauro Talevi made changes -
        Description We keep our story descriptions in Confluence and it would be nice to be able to export them similar to the current Redmine integration.

        There's currently a basic REST interface for newer Confluence versions which can be used to access content. Also the rich text editor adds quite some noise to the page content, which we have to deal with. We propose following conventions for an export:

        - Exports starts at a given root page and looks into all the child pages traversable from there. The root page is entered as the browser navigates to it (/display/space/pagename)
        - jBehave Story relevant parts are kept in containers. For a start we can use panel and info.
        - A table in the page is considered as example table.

        Attached are some samples how this looks in Confluence.

        Pull request will follow.
        We keep our story descriptions in Confluence and it would be nice to be able to import them to filesystem similarly to what is done for Redmine and XWiki.

        There's currently a basic REST interface for newer Confluence versions which can be used to access content. Also the rich text editor adds quite some noise to the page content, which we have to deal with. We propose following conventions for an import:

        - Import starts at a given root page and looks into all the child pages traversable from there. The root page is entered as the browser navigates to it (/display/space/pagename)
        - JBehave Story relevant parts are kept in containers. For a start we can use panel and info.
        - A table in the page is considered as example table.

        Attached are some samples how this looks in Confluence.

        Pull request will follow.
        Summary Add support for Confluence as REST provider Allow import to filesystem from Confluence
        Hide
        Mauro Talevi added a comment -

        Pulled https://github.com/ctpconsulting/jbehave-core/commit/9b362942c582361f1f61081bb66711c2a29e6b83

        Deployed new snapshot. Can you please try it out?

        Also, any plans to support the export functionality, i.e. from filesystem -> Confluence?

        Show
        Mauro Talevi added a comment - Pulled https://github.com/ctpconsulting/jbehave-core/commit/9b362942c582361f1f61081bb66711c2a29e6b83 Deployed new snapshot. Can you please try it out? Also, any plans to support the export functionality, i.e. from filesystem -> Confluence?
        Hide
        Thomas Hug added a comment -

        Thanks Mauro! I'll give it a spin asap.

        Regarding export to Confluence, it seems the current REST prototype API does only support read operations (except for page labels). For more advanced operations, we'd have to use either the XML-RPC or the SOAP API. Both probably not well placed in a REST module but if there's interest in the functionality we can certainly look at it.

        Show
        Thomas Hug added a comment - Thanks Mauro! I'll give it a spin asap. Regarding export to Confluence, it seems the current REST prototype API does only support read operations (except for page labels). For more advanced operations, we'd have to use either the XML-RPC or the SOAP API. Both probably not well placed in a REST module but if there's interest in the functionality we can certainly look at it.
        Hide
        Mauro Talevi added a comment -

        Yes, I agree that that would be better placed in a specific jbehave-confluence module.

        Ok, let me know if snapshot works and we can close issue off. I'd like to release 3.9.1 this week.

        Show
        Mauro Talevi added a comment - Yes, I agree that that would be better placed in a specific jbehave-confluence module. Ok, let me know if snapshot works and we can close issue off. I'd like to release 3.9.1 this week.
        Hide
        Thomas Hug added a comment -

        Looks good!

        Show
        Thomas Hug added a comment - Looks good!
        Mauro Talevi made changes -
        Resolution Fixed [ 1 ]
        Status Open [ 1 ] Resolved [ 5 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Thomas Hug
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: