Guidelines for developers and licenses

Guidelines and Policies for the team to follow

Guidelines for contributors and new developers

• Contributor Guidelines: Getting started
• How to use Git, GitHub, Pull Requests and merge conflicts

Guidelines for the core team

• Google Cloud Backup (separate repo for documenation; delegated to Chris)
• Temporary Docker Servers to outsource pipeline development and integration
• Internal Quick Start Guide: What services/servers do we have to get started as core-team member?
• Contributor Guidelines: Kanbans and Issues
• Guidelines for AWS Backups and GCP Backups Detailed Backup Strategy
• Domains: Guidelines on how to handle domains and e-mails
• Continuous integration: CI with Github Actions
• Flight Rules
• Native Apps: Releases & Testing: Everything about iOS and Android applications
• Giving Elastic Search logs to externals: We can give access to our Kibana to externals to download or search for specific logs
• Oauth2 Flows: Infos on how to test Oauth 2 Keycloak Authentication different flows
• Kibana Elastic: GuideLines for Kibana Elasticsearch

Guidelines for Web Components

• How to create a web-component that meets all the requirements for publication
• How to implement a web-component in your application
• How to publish your web-component on the Open Data Hub Store

Naming of Web Components

1. All web components html tag names have to (mandatory) start with "odh-". (policy created on April 2nd, 2021)
2. All web components html tag names have NOT to (mandatory) include "webcomp", "widget" or any generic abbreviation. Use the git repo name, which is "webcomp-", replacing "webcomp-" through "odh-". (policy created on April 2nd, 2021)
3. All web components titles have NOT to (mandatory) include "Web Component" now "Widget". (policy created on April 2nd, 2021)

Software Licenses

1. All repositories have to (mandatory) include a license under which the source code is released. By default we release source code in our repositories under the AGPL-3.0-or-later.

Content Licenses

1. All repositories should (optional) include licenses for content (like pictures, icons, text other media) under which we or the authors release them. By default we release content in our repositories under the CC0-1.0.

REUSE

1. All repositories should be REUSE compliant, find our REUSE guidlines here.

Trademark Policy

1. All repositories should (optional) contain a trademark.md file, to explain how third parties have to handle contained trademarks.

Analytics of web apps

1. All web apps have to (mandatory) include analytics to be able to analyze the use of the tool and plan future investments. (policy created on April 2nd, 2021)