Skip to content

First documentation pages #346

Open
@hartig

Description

@hartig

As a first set of documentation pages for potential users of HeFQUIN (users != developers who want to work on HeFQUIN itself), we need the following pages.

  • How to start the Web service via Docker, change the federation description that it uses, and how to issue queries to the service.
  • How to start the Web service from the latest release package, change the federation description that it uses, and how to issue queries to the service.
  • How to run queries using the CLI tool in the latest release package, including a detailed description of the arguments of the CLI tool.
  • How to run queries using the latest source code version of the CLI tool or the Web service.
  • How to specify the federation to be queried, including a documentation of the most important parts of the RDF vocabulary defined for this purpose.
  • Additionally, we need to create a README.txt file that we put in the top-level directory of the release packages and that contains a short version of these points above, including pointers to the respective documentation pages.
  • A similar summary of these points needs to be added to the README.md of the repo.

/cc @keski

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions