diff --git a/assets/scss/_variables_project.scss b/assets/scss/_variables_project.scss index f90fff6..c772230 100644 --- a/assets/scss/_variables_project.scss +++ b/assets/scss/_variables_project.scss @@ -10,4 +10,45 @@ $enable-shadows: false; $primary: #046EFA; $secondary: #E4E6F0; $dark: #2A2C34; +$success: #1A8754; +$primary-bg-subtle-dark: #3c3f44; + +.block-text-container { + display: grid; + grid-template-columns: auto; + justify-content: center; +} + +.block-text { + display: grid; + max-width: 600px; + padding-left: 1.5rem; + padding-right: 1.5rem; +} + +.logo-container { + display: grid; + justify-content: center; + align-content: center; + align-items: center; + + grid-template-columns: repeat(4, max-content); + + @media screen and (max-width: 1024px) { + grid-template-columns: repeat(3, max-content); + } + + @media screen and (max-width: 720px) { + grid-template-columns: max-content; + } + + gap: 2rem; + column-gap: 4rem; + & > div { + text-align: center; + } +} + + + diff --git a/content/en/_index.md b/content/en/_index.md index e27c1d5..90322ca 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -19,7 +19,21 @@ to deliver innovative solutions for data exchange networks. {{< /blocks/cover >}} -{{< blocks/section color="300" type="row" >}} +{{< blocks/section color="white" type="row" >}} +
+

Backed by Leading Companies

+
+
+
+
+
+
+
+
+
+
+
+ {{< /blocks/section >}} {{< blocks/section color="dark" type="row" >}} diff --git a/content/en/community/_index.md b/content/en/community/_index.md deleted file mode 100644 index 3f237b8..0000000 --- a/content/en/community/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Community -menu: {main: {weight: 40}} ---- - - diff --git a/content/en/documentation/_index.md b/content/en/documentation/_index.md index 41caf94..88fd6be 100755 --- a/content/en/documentation/_index.md +++ b/content/en/documentation/_index.md @@ -1,6 +1,5 @@ --- title: Documentation -linkTitle: Docs menu: {main: {weight: 20}} weight: 20 @@ -9,24 +8,44 @@ cascade: --- {{% pageinfo %}} -This is a placeholder page that shows you how to use this template site. +Welcome to the EDC, a framework for building globally-scalable data sharing services. {{% /pageinfo %}} + +Many organizations face the challenge of securely sharing data with their partners or other trusted third parties. In +the past, this has been the realm of proprietary EDI solutions. EDC is an alternative to these systems built on the +concept of [dataspaces](https://dataspace.eclipse.org/). EDC is a set of components that enable developers to create +dataspaces using the following building blocks: -This section is where the user documentation for your project lives - all the -information your users need to understand and successfully use your project. +- **Identity service** for managing and verifying organizational credentials + using [DIDs](https://www.w3.org/TR/did-core/) + and [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) or OAuth2 tokens. +- **Catalog service** for publishing and securing assets that can be shared with other organizations. +- **Control plane services** for the automated creation and processing of data usage agreements that grant access to + data. +- **Data plane and monitoring services** for initiating and managing data transfers using off-the-shelf protocols such + as `HTTP`, `Kafka`, cloud object storage, or virtually any other technology. -For large documentation sets we recommend adding content under the headings in -this section, though if some or all of them don’t apply to your project feel -free to remove them or add your own. You can see an example of a smaller Docsy -documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which -lives in the [Docsy theme -repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to -copy its docs section. +EDC is designed to serve a range of use cases, including large AI data sets, API access, supply-chain data processing, +and research data sharing. + +EDC components are standards-based and implement +the [Dataspace Protocol Specification](https://github.com/eclipse-dataspace-protocol-base/DataspaceProtocol) +and [Decentralized Claims Protocol Specification](https://github.com/eclipse-dataspace-dcp/decentralized-claims-protocol). + +## What EDC is not + +EDC is not a data processing platform, integration framework, or messaging bus. EDC is also not a prepackaged system or +application. Rather, it is a toolbox for building customized distributions. As a generic toolbox, EDC: + +- Does not ship an installable distribution; those are provided by downstream projects that customize EDC to their + needs. +- Does not contain use case-specific features; those are added through EDC's *modularity and extension system.* +- Does not provide infrastructure for storing, processing, or moving data; EDC integrates with third-party *data planes* + to provide these services. + +## What Next? + +If you are new to EDC, start with the [Adopters Manual](for-adopters). If you are an experienced EDC developer and +want to take a deep-dive into the codebase, see the [Contributors Manual](for-contributors). -Other content such as marketing material, case studies, and community updates -should live in the [About](/about/) and [Community](/community/) pages. -Find out how to use the Docsy theme in the [Docsy User -Guide](https://docsy.dev/docs/). You can learn more about how to organize your -documentation (and how we organized this site) in [Organizing Your -Content](https://docsy.dev/docs/best-practices/organizing-content/). diff --git a/content/en/documentation/for-adopters/_index.md b/content/en/documentation/for-adopters/_index.md index 754d4b2..e868453 100644 --- a/content/en/documentation/for-adopters/_index.md +++ b/content/en/documentation/for-adopters/_index.md @@ -1,39 +1,8 @@ --- -title: For Adopters -description: What does your user need to know to try your project? +title: Adopters Manual weight: 20 --- -Many organizations face the challenge of securely sharing data with their partners or other trusted third parties. In -the past, this has been the realm of proprietary EDI solutions. EDC is an alternative to these systems built on the -concept of [dataspaces](https://dataspace.eclipse.org/). EDC is a set of components that enable developers to create dataspaces using the following -building blocks: - -- **Identity service** for managing and verifying organizational credentials using [DIDs](https://www.w3.org/TR/did-core/) - and [W3C Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) or OAuth2 tokens. -- **Catalog service** for publishing and securing assets that can be shared with other organizations. -- **Negotiation service** for the automated creation and processing of data usage agreements that grant access to data. -- **Data transfer and monitoring services** for automatically initiating and managing data transfers using off-the-shelf - protocols such as `HTTP`, `Kafka`, cloud object storage, or virtually any other technology. - -EDC is designed to serve a range of use cases, including large AI data sets, API access, supply-chain data processing, -and research data sharing. - -EDC components are standards-based and implement the [Dataspace Protocol Specification](https://github.com/eclipse-dataspace-protocol-base/DataspaceProtocol) -and [Decentralized Claims Protocol Specification](https://github.com/eclipse-dataspace-dcp/decentralized-claims-protocol). - -## What EDC is not - -EDC is not a data processing platform, integration framework, or messaging bus. EDC is also not a prepackaged system or -application. Rather, it is a toolbox for building customized distributions. As a generic toolbox, EDC: - -- Does not ship an installable distribution; those are provided by downstream projects that customize EDC to their - needs. -- Does not contain use case-specific features; those are added through EDC's *modularity and extension system* (more on - that below). -- Does not provide infrastructure for storing, processing, or moving data; EDC integrates with third-party *data planes* - to provide these services. - ## The Samples The quickest way to get started building with EDC is to work through diff --git a/content/en/documentation/for-contributors/_index.md b/content/en/documentation/for-contributors/_index.md index fd35693..88e538e 100644 --- a/content/en/documentation/for-contributors/_index.md +++ b/content/en/documentation/for-contributors/_index.md @@ -1,6 +1,5 @@ --- -title: For Contributors -description: What do your user need to know to develop with EDC? +title: Contributors Manual weight: 30 --- diff --git a/content/en/documentation/for-contributors/guidelines/_index.md b/content/en/documentation/for-contributors/guidelines/_index.md new file mode 100644 index 0000000..9aca25a --- /dev/null +++ b/content/en/documentation/for-contributors/guidelines/_index.md @@ -0,0 +1,169 @@ +--- +title: Contribution Guidelines +linkTitle: Guidelines +weight: 900 +--- + +Thank you for your interest in the EDC! This document provides guidelines and steps members are asked to follow when +contributing to the project. + +## Table of Contents + +* [Code Of Conduct](#code-of-conduct) +* [How to Contribute](#how-to-contribute) + * [Creating an Issue](#creating-an-issue) + * [Submitting a Pull Request](#submitting-a-pull-request) + * [Stale Issues and PRs](#stale-issues-and-prs) + * [Reporting Flaky Tests](#reporting-flaky-tests) +* [Project and Milestone Planning](#project-and-milestone-planning) + * [Milestones](#milestones) + * [Projects](#projects) + * [Releases](#releases) +* [Contact Us](#contact-us) + +## Code Of Conduct + +All community members are expected to adhere to +the [Eclipse Code of Conduct](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php"). + +## How to Contribute + +If you want to share a feature idea or discuss a potential use case, first check the existing issues and discussions to +see if it has already been raised. If not, open a discussion (not an issue). + +- For specific technology topics, use [GitHub discussions](https://github.com/features/discussions) + in the appropriate repository. +- For general topics (including project planning, relationship to other projects, etc.) use the [EDC + organization discussions](https://github.com/orgs/eclipse-edc/discussions). + +### Creating an Issue + +If you have identified a bug first check the existing issues to see if it has already been identified. If not, create +a new issue in the appropriate GitHub repository. Keep in mind the following: + +- We + use [GitHub's default label set](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) + extended by custom ones to classify issues and improve findability. +- If an issue appears to cover changes that will significantly impact the codebase, open a discussion before creating an + issue. +- If an issue covers a topic or the response to a question that may be interesting for further discussion, it should be + converted to a discussion instead of being closed. + +### Submitting a Pull Request + +Before submitting code to EDC, you should complete the following prerequisites: + +* **DO NOT** submit a PR without first filing an issue (bug) or opening a discussion (new feature). +* Have a thorough understanding of the EDC codebase, including all technical documentation and Decision Records in the + relevant repositories. +* Review the [Eclipse Project Handbook](https://www.eclipse.org/projects/handbook/#contributing). +* Review the [EDC Pull-Request Etiquette](pr-etiquette). +* Follow the [EDC Pull-Request Checklist](pr-checklist). + +#### Eclipse Contributor Agreement + +Before your contribution can be accepted by the project, you need to create and electronically sign +an [Eclipse Contributor Agreement (ECA)](http://www.eclipse.org/legal/ecafaq.php): + +1. Log in to the [Eclipse foundation website](https://accounts.eclipse.org/user/login/). You will + need to create an account within the Eclipse Foundation if you have not already done so. +2. Click on "Eclipse ECA", and complete the form. + +Be sure to use the same email address in your Eclipse Account that you intend to use when committing to GitHub. + + +### Stale Issues and PRs + +In order to keep our backlog clean, EDC uses a bot that labels and closes old issues and PRs. The following table +outlines this process: + +| | Stale After | Closed After Stale | +|:-----------------------|------------:|-------------------:| +| Issue without assignee | 14 days | 7 days | +| Issue with assignee | 28 days | 7 days | +| PR | 7 days | 7 days | + +Note that updating an issue, for example by commenting, will remove the `stale` label and reset the counters. However, +we ask the community **not to abuse** this feature (e.g., periodically commenting "what's the status?" would qualify as +abuse). If an issue receives no attention, usually there are reasons for it. To avoid closed issues, it's recommended to +clarify in advance whether a feature fits into the project roadmap by opening a discussion, which are not automatically +closed. + +### Reporting Flaky Tests + +If you discover a randomly failing ("flaky") test, please check whether an issue for that already +exists. If not, create one, making sure to provide a meaningful description and a link to the failing run. Also include +the `Bug` and `FlakyTest` labels and assign it to an author of the relevant code. If assigning the issue is not +possible due to missing rights, just comment and @mention the author/last editor. + +Be sure not restart the run, as this will overwrite the results. Instead, push an empty commit to trigger another run. + +```bash +git commit --allow-empty -m "trigger CI" && git push +``` + +Note that issues labeled with `Bug` and `FlakyTest` are prioritized. + +## Non-Code Contributions + +Non-code contributions are another valued way to contribute. Examples include: + +- Evangelizing EDC + - Helping to develop the community by hosting events, meetups, summits, and hackathons +- Community education + - Answering questions on GitHub, Discord, etc. + - Writing documentation + - Other writing (Blogs, Articles, Interviews) + +## Project and Milestone Planning + +We use milestones to set a common focus for a period of 6 to 8 weeks. The group of committers chooses issues based on +customer needs and contributions we expect. + +### Milestones + +Milestones are organized at the [GitHub Milestones page](https://github.com/eclipse-edc/Connector/milestones). +They are numbered in ascending order. There, contributors, users, and adopters can track the progress. + +Please note that the due date of a milestone does not imply any guarantee that all linked issued will +be resolved by then. + +When closing the current milestone, issues that were not resolved within a milestone phase will be +reviewed to evaluate their relevance and priority, before being assigned to the next milestone. + +#### Issues + +Every issue that should be addressed during a milestone phase is assigned to it by using the +`Milestone` feature for linking both items. This way, the issues can easily be filtered by +milestones. + +#### Pull Requests + +Pull requests are not assigned to milestones as their linking to issues is sufficient to track +the relations and progresses. + +### Projects + +The [GitHub Projects page](https://github.com/eclipse-edc/Connector/projects) +provides a general overview of the project's working items. Every new issue is automatically assigned +to the ["Dataspace Connector" project](https://github.com/orgs/eclipse-edc/projects/3). +It can be unassigned or moved to any other project that is provided. + +In every project, an issue passes four stages: `Backlog`, `In progress`, `Review in progress`, and `Done`, +independent of their association to a specific milestone. + +### Releases + +Please find more information about our release approach [here](developer/releases.md). + +## Contact Us + +If you have questions or suggestions, do not hesitate to contact the project developers via +the [project's "dev" list](https://dev.eclipse.org/mailman/listinfo/edc-dev). You may also want to join +our [Discord server](https://discord.gg/n4sD9qtjMQ). + +The project holds a biweekly meeting on fridays 2-3 p.m. (CET) to give community members the +opportunity to get in touch with the committer team. We meet in the "general" voice channel. +Schedule details are [on GitHub](https://github.com/eclipse-edc/Connector/discussions/1303). + +_If you have a "contributor" or "committer" status, you will also have access to private channels._ \ No newline at end of file diff --git a/content/en/documentation/for-contributors/guidelines/pr-checklist/_index.md b/content/en/documentation/for-contributors/guidelines/pr-checklist/_index.md new file mode 100644 index 0000000..ddbfc48 --- /dev/null +++ b/content/en/documentation/for-contributors/guidelines/pr-checklist/_index.md @@ -0,0 +1,69 @@ +--- +title: PR Check List +weight: 40 +--- + +It's recommended to submit a draft pull request early on and add people previously working on the same code as +reviewers. Make sure all automatic checks pass before marking it as "ready for review": + +Before submitting a PR, please follow the steps below. + +### Open a Discussion or File an Issue + +Do not submit a PR without first opening an issue (if the PR resolves a bug) or creating a discussion. If a bug fix +requires a significant change or touches on critical code paths (e.g. security-related), open a discussion first. + +### Coding Style + +All code contributions must strictly adhere to the [Style Guide](styleguide.md) and design principles outlined in the +Contributor Technical Documentation. **PRs that do not adhere to these rules will be rejected.** + +All artifacts must include the following copyright header, replacing the fields enclosed by curly brackets "{}" with +your own identifying information. (Don't include the curly brackets!) Enclose the text in the appropriate comment syntax +for the file format. + +```text +Copyright (c) {year} {owner}[ and others] + +This program and the accompanying materials are made available under the +terms of the Apache License, Version 2.0 which is available at +https://www.apache.org/licenses/LICENSE-2.0 + +SPDX-License-Identifier: Apache-2.0 + +Contributors: + {name} - {description} +``` + +### Commit Messages + +Git commit messages should comply with the following format: + +``` +(): +``` + +Use the [imperative mood](https://github.com/git/git/blob/master/Documentation/SubmittingPatches) +as in "Fix bug" or "Add feature" rather than "Fixed bug" or "Added feature" and +[mention the GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) +e.g. `chore(transfer process): improve logging`. + +All committers and all commits, are bound to +the [Developer Certificate of Origin.](https://www.eclipse.org/legal/DCO.php) +As such, all parties involved in a contribution must have valid ECAs. Additionally, commits can +include a ["Signed-off-by" entry](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git). + +### Testing and Documentation + +All submissions must include extensive test coverage and be fully documented: + +* Add meaningful unit tests and integration tests when appropriate to verify your submission acts as expected. +* All code must be documented. Interfaces and implementation classes must have Javadoc. Include inline documentation + where code blocks are not self-explanatory. +* If a new module has been added or a significant part of the code has been changed, and you should be seen as the + contact person for any further changes, please add appropriate + information to the [CODEOWNERS](https://github.com/eclipse-edc/Connector/blob/main/CODEOWNERS) + file. You can find instructions on how to do this at . + Please note that this file does not represent all contributions to the code. What persons and organizations + actually contributed to each file can be seen on GitHub and is documented in the license headers. + diff --git a/content/en/documentation/for-contributors/guidelines/pr-etiquette/_index.md b/content/en/documentation/for-contributors/guidelines/pr-etiquette/_index.md new file mode 100644 index 0000000..70b6f4c --- /dev/null +++ b/content/en/documentation/for-contributors/guidelines/pr-etiquette/_index.md @@ -0,0 +1,76 @@ +--- +title: Pull Request Etiquette +linkTitle: PR Etiquette +weight: 20 +--- +## Authors + +PRs should adhere to the following rules. + +- Familiarize yourself with [coding style](./styleguide.md), [./architectural patterns](coding-principles.md), + and other contribution guidelines. +- No surprise PRs. Before submitting a PR, open a discussion or an issue outlining the planned work and give + people time to comment. Unsolicited PRs may get ignored or rejected. +- Create focused PRs. Work should be focused on one particular feature or bug. Do not create broad-scoped PRs that + solve multiple issues or span signficant portions of the codebase as they will be rejected outright. +- Provide a clear PR description and motivation. This makes the reviewer's life much + easier. It is also helpful to outline the broad changes that were made, e.g. "Changes the schema of XYZ-Entity: + the `age` field changed from `long` to `String`". +- If 3rd party dependencies are introduced, note them in the PR description and explain why they are necessary. +- Stick to the established code style, please refer to + the [styleguide document](./styleguide.md). +- All tests should be green, especially when your PR is in `"Ready for review"` +- Mark PRs as `"Ready for review"` only when the PR is complete. No additional commits should be pushed other than to + incorporate review comments. +- Merge conflicts should be resolved by squashing all commits on the PR branch, rebasing onto `main,` and + force-pushing. Do this when your PR is ready to review. +- If you require a reviewer's input while it's still in draft, please contact the designated reviewer using + the `@mention` feature and let them know what you'd like them to look at. +- Request a review from one of the [technical committers](pr_etiquette.md#the-technical-committers). Requesting a review + from anyone else is still possible, and + sometimes may be advisable, but only committers can merge PRs, so be sure to include them early on. +- Re-request reviews after all remarks have been adopted. This helps reviewers track their work in GitHub. +- If you disagree with a committer's remarks, feel free to object and argue, but if no agreement is reached, you'll have + to either accept the committer's decision or withdraw your PR. +- Be civil and objective. No foul language, insulting or otherwise abusive language will be tolerated. +- The PR titles must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). + - The title must follow the format as `(): `. + `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test` are allowed for the + ``. + - The length must be kept under 80 characters. + - + See [check-pull-request-title job of GitHub workflow](https://github.com/eclipse-edc/.github/blob/main/.github/workflows/scan-pull-request.yml) + for checking details. + +## Reviewers + +- Please complete reviews within two business days or delegate to another committer, removing yourself as a reviewer. +- If you have been requested as reviewer, but cannot do the review for any reason (time, lack of knowledge in particular + area, etc.) please comment that in the PR and remove yourself as a reviewer, suggesting a stand-in. The **CODEOWNERS** + document + should help with that. +- Don't be overly pedantic. +- Don't argue basic principles (code style, architectural decisions, etc.) +- Use the `suggestion` feature of GitHub for small/simple changes. +- The following could serve you as a review checklist: + - No unnecessary dependencies in `build.gradle.kts` + - Sensible unit tests, prefer unit tests over integration tests wherever possible (test runtime). Also check the + usage of test tags. + - Code style + - Simplicity and "uncluttered-ness" of the code + - Overall focus of the PR +- Don't just wave through any PR. Please take the time to look at them carefully. +- Be civil and objective. No foul language, insulting or otherwise abusive language will be tolerated. The goal is to + _encourage_ contributions. + +## The technical committers + +_(as of Sept 15, 2024)_ + +- @wolf4ood +- @jimmarino +- @bscholtes1A +- @ndr_brt +- @ronjaquensel +- @juliapampus +- @paullatzelsperger diff --git a/content/en/documentation/for-contributors/guidelines/styleguide/_index.md b/content/en/documentation/for-contributors/guidelines/styleguide/_index.md new file mode 100644 index 0000000..1d48ef9 --- /dev/null +++ b/content/en/documentation/for-contributors/guidelines/styleguide/_index.md @@ -0,0 +1,46 @@ +--- +title: Style Guide +weight: 30 +--- +In order to maintain a coherent codebase, every contributor must adhere to the project style guidelines. We assume +contributors will use a modern code editor with support for automatic code formatting. + +## Checkstyle configuration + +Checkstyle is a [tool](https://checkstyle.sourceforge.io/) that statically analyzes source code against a set of given +rules formulated in an XML document. Checkstyle rules are included in all EDC code repositories. Many modern IDEs have a +plugin that runs Checkstyle analysis in the background. + +Our checkstyle config is based on the [Google Style](https://checkstyle.sourceforge.io/google_style.html) with a few +additional rules such as the naming of constants and Types. + +_Note: currently we do **not** enforce the generation of Javadoc comments, even though documenting code is **highly** +recommended._ + +### Running Checkstyle + +Checkstyle is run through the `checkstyle` Gradle Plugin during `gradle build` for all code repositories. In addition, +Checkstyle is enabled in all GitHub Actions pipelines for PR validation. If checkstyle any violations are found, the +pipeline will fail. We therefore recommend configuring your IDE to run Checkstyle: + +- [IntelliJ IDEA plugin [recommended]](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) +- [Eclipse IDE [recommended]](https://checkstyle.org/eclipse-cs/#!/) + +## IntelliJ Code Style Configuration + +If you are using Jetbrains IntelliJ IDEA, we have created a specific code style configuration that will automatically +format your source code according to that style guide. This should eliminate most of the potential Checkstyle violations +from the get-go. However, some code may need to be reformatted manually. + +## Intellij SaveActions Plugin + +To assist with automated code formatting, you may want to use +the [SaveActions plugin](https://plugins.jetbrains.com/plugin/7642-save-actions) for IntelliJ IDEA. Unfortunately, +SaveActions has no export feature, so you will need to manually apply this configuration: + +![](save_actions_screenshot.png) + +## Generic `.editorConfig` + +For most other editors and IDEs we've supplied `.editorConfig` files. Refer to +the [official documentation](https://editorconfig.org) for configuration details since they depend on the editor and OS. \ No newline at end of file diff --git a/content/en/documentation/for-contributors/guidelines/styleguide/save_actions_screenshot.png b/content/en/documentation/for-contributors/guidelines/styleguide/save_actions_screenshot.png new file mode 100644 index 0000000..10ae06c Binary files /dev/null and b/content/en/documentation/for-contributors/guidelines/styleguide/save_actions_screenshot.png differ diff --git a/content/en/documentation/overview/_index.md b/content/en/documentation/overview/_index.md deleted file mode 100644 index 5c51c56..0000000 --- a/content/en/documentation/overview/_index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Overview -description: Here's where your user finds out if your project is for them. -weight: 1 ---- - -{{% pageinfo %}} -This is a placeholder page that shows you how to use this template site. -{{% /pageinfo %}} - - -The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or put your overview contents in the Documentation landing page (like in the Docsy User Guide). - -Try answering these questions for your user in this page: - -## What is it? - -Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want. - -## Why do I want it? - -Help your user know if your project will help them. Useful information can include: - -* **What is it good for?**: What types of problems does your project solve? What are the benefits of using it? - -* **What is it not good for?**: For example, point out situations that might intuitively seem suited for your project, but aren't for some reason. Also mention known limitations, scaling issues, or anything else that might let your users know if the project is not for them. - -* **What is it *not yet* good for?**: Highlight any useful features that are coming soon. - -## Where should I go next? - -Give your users next steps from the Overview. For example: - -* [Getting Started](/docs/getting-started/): Get started with $project -* [Examples](/docs/examples/): Check out some example code! - diff --git a/content/en/project/_index.md b/content/en/project/_index.md new file mode 100644 index 0000000..cb6113c --- /dev/null +++ b/content/en/project/_index.md @@ -0,0 +1,5 @@ +--- +title: Community +menu: {main: {weight: 40}} +type: project +--- diff --git a/hugo.toml b/hugo.toml index 7c42182..ee1d384 100644 --- a/hugo.toml +++ b/hugo.toml @@ -127,7 +127,7 @@ prism_syntax_highlighting = false [params.copyright] authors = "Eclipse Contributors | [Vector art by Freepik](https://www.freepik.com)" -from_year = 2018 +from_year = 2021 # User interface configuration [params.ui] diff --git a/layouts/404.html b/layouts/404.html index 1a9bd70..d32828c 100644 --- a/layouts/404.html +++ b/layouts/404.html @@ -2,6 +2,5 @@

Not found

Oops! This page doesn't exist. Try going back to the home page.

-

You can learn how to make a 404 page like this in Custom 404 Pages.

{{- end }} diff --git a/layouts/_default/project.html b/layouts/_default/project.html new file mode 100644 index 0000000..0014ee0 --- /dev/null +++ b/layouts/_default/project.html @@ -0,0 +1,128 @@ +{{ define "main" -}} + +
+
+
+
+
+

Welcome to the EDC Community

+

+
Do you have a question, want to file an issue, or are interested in contributing to EDC?
+
+
+
+
+
+ We expect all members to adhere to the + Eclipse Code of Conduct +
+
+
+

  Key Repositories

+
+ EDC is hosted in multiple repositories organized by function. The key EDC repositories are: +
+    + Connector - Control Plane and + Data Plane +
+
+    + Federated Catalog - Data + Catalog +
+
+    + Identity Hub - Decentralized + Identity +
+
+    + MVD - Complete + Dataspace Setup +
+
+    + Samples - Getting Started + Tutorials +
+
+ Cloud-specific extensions are hosted in individual technology repositories. +
+
+
+

  Asking a Question

+
+ If you have a question about how to use EDC, please ask on Discord + +
+ If you have a question about the EDC codebase or would like to explore + the feasibility of a new feature, open a discussion in the appropriate GitHub repository. Please do not open + a discussion about how to use EDC (use Discord instead). +
+
+

  Filing an Issue

+
+ If you think you have identified a bug please do the following: +
+ +   If you have a + setup question or a build problem, do not file an issue, open a discussion. + +
+
+ 1  Search existing issues in the appropriate GitHub + repository's issue page. +
+
+ 2  If an issue appears to cover changes that will + significantly impact the codebase, open a discussion before creating an issue. +
+
+ 3  Label the issue and include clear steps to reproduce + it. +
+
+ 4  The issue will have a greater chance of being + addressed if you include a self-contained test case. +
+
+   The project uses a bot that + closes stale issues. Details can be found in the Contribution Guidelines. +
+
+
+

  Contributing

+
+ We welcome contributions and appreciate your interest. If you would like to contribute to EDC: +
+ 1  Invest time in thoroughly understanding the EDC + codebase and reading the Contribution + Guidelines. +
+
+ 2  We highly recommend starting by contributing + documentation. +
+
+ 3  Chose issues labeled Good First Issue. + Please do + not select other issues unless asked by a committer. +
+
+ 4  Request feedback early by opening a discussion and + submitting a draft PR. +
+
+
+
+
+ + +{{ end }} \ No newline at end of file diff --git a/static/images/logos/amadeus.logo.svg b/static/images/logos/amadeus.logo.svg new file mode 100644 index 0000000..f9fcd46 --- /dev/null +++ b/static/images/logos/amadeus.logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/static/images/logos/aws.logo.svg b/static/images/logos/aws.logo.svg new file mode 100644 index 0000000..80192a1 --- /dev/null +++ b/static/images/logos/aws.logo.svg @@ -0,0 +1,38 @@ + + + + + + + + + + + + diff --git a/static/images/logos/bmw.logo.svg b/static/images/logos/bmw.logo.svg new file mode 100644 index 0000000..6bd9a4e --- /dev/null +++ b/static/images/logos/bmw.logo.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/static/images/logos/fraunhofer.logo.svg b/static/images/logos/fraunhofer.logo.svg new file mode 100644 index 0000000..e74de14 --- /dev/null +++ b/static/images/logos/fraunhofer.logo.svg @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/static/images/logos/google.logo.svg b/static/images/logos/google.logo.svg new file mode 100644 index 0000000..d316b5d --- /dev/null +++ b/static/images/logos/google.logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/static/images/logos/huawei.logo.svg b/static/images/logos/huawei.logo.svg new file mode 100644 index 0000000..d2a74c2 --- /dev/null +++ b/static/images/logos/huawei.logo.svg @@ -0,0 +1,22301 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/images/logos/microsoft.logo.svg b/static/images/logos/microsoft.logo.svg new file mode 100644 index 0000000..8712b1a --- /dev/null +++ b/static/images/logos/microsoft.logo.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/static/images/logos/sap.logo.svg b/static/images/logos/sap.logo.svg new file mode 100644 index 0000000..b9294e4 --- /dev/null +++ b/static/images/logos/sap.logo.svg @@ -0,0 +1,9 @@ + + + + + + + + +