Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docu Improvements #30

Closed
kurzum opened this issue Nov 2, 2022 · 3 comments
Closed

Docu Improvements #30

kurzum opened this issue Nov 2, 2022 · 3 comments
Milestone

Comments

@kurzum
Copy link
Member

kurzum commented Nov 2, 2022

@holycrab13 holycrab13 added this to the 2.1.0 milestone Mar 16, 2023
@manonthegithub
Copy link
Collaborator

manonthegithub commented May 12, 2023

I suggest the followinf structure of the DOCS:

# Table of Contents
* Overview
* Use cases
* Running your own Databus Server
  * Run with Docker
  * Configuration
  * HTTPS and Proxy SETUP
* Usage
  * Web Interface
    * Publish
    * Query
    * Collections
  * API
    * Api  DOCS
    * Examples
  * Mods
  * Databus Client
* Organising your data (Model)
  * Metadata
    * Group
    * Artifact
    * Version
    * Distribution
  * URI Design
  * Versioning
* Development Environment

please feel free to propose your improvements!
@kurzum After we decide on the structure we will be able split the chapters between the team members

@kurzum
Copy link
Member Author

kurzum commented May 15, 2023

* Overview
* Use cases (SH)
* Running your own Databus Server (KY)
  * Run with Docker
  * Configuration
  * HTTPS and Proxy SETUP
* Usage
  * Web Interface (MD)
    * Publish # Autocompletion of the JSON-LD should be there
    * Browsing Data # (page for explanations of the web interface)
    * Collections
  * API (KY)
    * Quickstart Examples (Publish, Download)
    * Complete Api  DOCS
  * Mods (Denis)
  * Databus Client (Fabian)
* Organising your data (Model) MD (Review and fix)
  * Metadata
    * Group
    * Artifact
    * Version
    * Distribution
  * URI Design
  * Versioning
  * Content Variants
* Development Environment

@manonthegithub
Copy link
Collaborator

manonthegithub commented May 15, 2023

Table of contents

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants