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

Add get involved page #214

Merged
merged 4 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/config/_default/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,11 @@ menu:
URL: /community/#sm-tag-partnerships
weight: 3

- parent: community
name: Get Involved
URL: /community/get-involved
weight: 4

# --- Events ---
- identifier: events
URL: /events
Expand Down
84 changes: 84 additions & 0 deletions src/content/community/get-involved/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
type: community/single
position: "Community"
aliases: /get-involved
title: "Get Involved and How to Collaborate​"
subtitle: "The Open Data Hub team warmly invites new partners and users to become part of our journey. We offer a variety of pathways to engage with the project. Depending on your interest on the Open Data Hub, we welcome your participation to the project in one of the roles that we have envisioned:​"

rows:
- title: "As a User I can…​"
description: "​…explore the data in the datasets.​
<br>
Choose a dataset from the list of [**Datasets**](https://opendatahub.com/datasets/) and start gathering data from it. You can then provide any kind of feedback on the dataset: reports about any malfunctions, suggestions for improvements or new features, and so on.​ Moreover, if you are interested in datasets that are not yet in our collection, get in touch with the Open Data Hub team to discuss your request.​
<br>
<br>
​…browse our collection of pre-built Web Components​
<br>
Enhance your website or app with ease: browse the list of [**available Web Components**](https://opendatahub.com/web-components/), choose one that you are interested in, try it out, then send feedback to their developers if you feel something is wrong or missing.​"
bg_darker: true
partial: text.html

- title: "​As a Data Provider I can…"
description: "Share with an Open Data Licence the data you own, that can prove interesting for the Open Data Hub, for example because they complement existing data in the Open Data Hub or they pertain to an area which is not yet covered. Let your Open Data be freely used by App Developers in their applications.​
<br>
<br>
Note: A [**Data Provider**](https://opendatahub.readthedocs.io/en/latest/datasets.html#data-providers) is an entity (be it a private company, a public institution, or a citizen) that gathers data on a regular basis from various sensors or devices and stores them in some kind of machine-readable format."
bg_darker: false
partial: text.html

- title: "As an App Developer I can…​"
description: "​…harvest data exposed by the dataset.​
<br>
Browse the list of [**Datasets**](https://opendatahub.com/datasets/) to see what types of data are contained in the datasets, and think how they can be used.​ For this purpose, we maintain an updated list of available [**Datasets** ](https://opendatahub.com/datasets/)with links to the API to access them.​
<br>
<br>
…build an application with the data.​
<br>
Write code for an app that combines the data you can harvest from the available datasets in various, novel way.​
To reach this goal, you need to access the APIs, their documentation, and the datasets. It is then your task to discover how you can reuse the data in your code.​
<br>
<br>
​…integrate Open Data Hub data using Web Components.​
<br>
The Open Data Hub team and their partner have developed a [**library of Web Components**](https://webcomponents.opendatahub.com/) that can be integrated in existing websites or used as guidance to develop new Web Components.​
<br>
<br>
​…publish my app in Open Data Hub.​
<br>
As soon as you have developed a stable version of your app, get in touch with us: We plan to maintain an updated list of apps based on our dataset.​
<br>
<br>
​No software installation is needed. Develop in a language of your choice an application that uses our data."
bg_darker: true
partial: text.html

- title: "As an Open Data Hub Core Hacker I can…​"
description: "…help shape the future of Open Data Hub.​
<br>
Participate in the development of Open Data Hub: Build new data collectors, extend the functionality of the broker, integrate new datasets on the existing infrastructure, develop new stable API versions.​
<br>
<br>
To be able to become a core hacker, however, requires a few additional tasks to be carried out:​
<br>
<br>
1. ​Learn how to successfully integrate your code with the existing code-base and how to interact with the Open Data Hub team. In other words, you need to check the [**Developer’s Flight Rules**](https://github.com/noi-techpark/documentation/blob/main/README.md)​
<br>
<br>
2. Understand the Open Data Hub **_Architecture_**
<br>
<br>
3. Install the necessary software on your local workstation (be it a physical workstation, a virtual machine, or a Docker instance), including PostgreSQL with postgis extension, JDK, git.​
<br>
<br>
4. Set up all the services needed (database, application server, and so on).​
<br>
<br>
5. Clone our git repositories. To successfully complete these tasks, please read the **_[How to set up your local ](https://opendatahub.readthedocs.io/en/latest/howto/generic/development.html#development)[Development Environment](https://opendatahub.readthedocs.io/en/latest/howto/generic/development.html#development)_** tutorial, which guides you stepwise through all the required set up and configuration, along with some troubleshooting advice.​
<br>
<br>
6. Coding. That’s the funniest part, enjoy!​"
bg_darker: false
partial: text.html


---
1 change: 1 addition & 0 deletions src/data/community.yml
Original file line number Diff line number Diff line change
Expand Up @@ -334,3 +334,4 @@ team:
position: Team Leader
img: "img/experts/PatrickOhnewein.jpg"
company: NOI Techpark Südtirol - Alto Adige
########################### Get involved ###########################
28 changes: 14 additions & 14 deletions src/themes/odh-fbe/layouts/community/list.html
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
{{/*
SPDX-FileCopyrightText: NOI Techpark <[email protected]>
SPDX-FileCopyrightText: NOI Techpark <[email protected]>

SPDX-License-Identifier: AGPL-3.0-or-later
*/}}
*/}}

{{ define "main" }}

{{ partial "title-cta.html" .Params }}

<a id="sm-tag-data-providers"></a>
<!-- DATA PROVIDERS -->
<section class="pb-4">
{{ partial "title-section.html" site.Data.community.providers }}
<!-- DATA PROVIDERS -->
<section class="pb-4">
{{ partial "title-section.html" site.Data.community.providers }}
{{ partial "logos.html" site.Data.community.providers }}
</section>
</section>

<a id="sm-tag-data-consumers"></a>
<a id="sm-tag-data-consumers"></a>
<!-- DATA CONSUMERS -->
<section class="bg-darker pb-4">
{{ partial "title-section.html" site.Data.community.consumers }}
<section class="bg-darker pb-4">
{{ partial "title-section.html" site.Data.community.consumers }}
{{ partial "logos.html" site.Data.community.consumers }}
</section>
</section>

<a id="sm-tag-partnerships"></a>
<a id="sm-tag-partnerships"></a>
<!-- Partnerships and Alliances -->
<section class="pb-4">
{{ partial "title-section.html" site.Data.community.partnerships }}
<section class="pb-4">
{{ partial "title-section.html" site.Data.community.partnerships }}
{{ partial "logos.html" site.Data.community.partnerships }}
</section>
</section>

<!-- DEVELOPERS -->
<!--
Expand Down
16 changes: 16 additions & 0 deletions src/themes/odh-fbe/layouts/community/single/list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{{/*
SPDX-FileCopyrightText: NOI Techpark <[email protected]>

SPDX-License-Identifier: AGPL-3.0-or-later
*/}}

{{ define "main" }}

{{ partial "title.html" .Params }}

{{ range .Params.rows }}
<div {{ if .bg_darker }}class="bg-darker"{{ end }}>
{{ partial .partial . }}
</div>
{{ end }}
{{ end }}
1 change: 1 addition & 0 deletions src/themes/odh-fbe/layouts/partials/text.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<section>
<div class="container">
<div class="col-12">
<h2>{{ .title | markdownify }}</h2>
<p>{{ .description | markdownify }}</p>
</div>
</div>
Expand Down
Loading