Uploaded image for project: 'Marmotta'
  1. Marmotta
  2. MARMOTTA-629

Improve documentation of core module to make basic resource retrieval obvious

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      The Marmotta core module documentation at
      http://marmotta.apache.org/platform/core-module.html

      provides no useful information - in particular in regard to the basic ResourceWebService.

      The only place I could find out how to access this was through embedded links in the Linked Data Explorer.

      In particular this should be highlighted in the getting started guide - so there is an immediate test available to the user after importing some data.

      (obviously documentation is incomplete - just wanted to highlight the single biggest thing). The use case of making data available after importing should have easy to understand examples for content and locale negotiation, and a link to the SPARQL module for SPARQL access.

      rationale - no actual deployment is going to be reliant on the inbuilt explorer - so this is the first use case a potential deployer needs to get familiar with.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              rob@metalinkage.com.au Rob Atkinson
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: