Skip to content

Commit

Permalink
docs: add screenshots to readme (#566)
Browse files Browse the repository at this point in the history
* docs: add Screenshots to Readme

* docs: add task to Release Work Breakdown

* docs: adding max-width for screenshots
  • Loading branch information
tmberthold authored Dec 21, 2023
1 parent 23dfcb2 commit 17c24f9
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 15 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
- [ ] Write or review a `Deployment Migration Notes` section.
- [ ] Write or review a release summary.
- [ ] Remove empty sections from the patch notes.
- [ ] Review the Screenshots in the Readme and update them if necessary.
- [ ] Merge the `release-prep` PR.
- [ ] Wait for the main branch to be green.
- [ ] Create a release and re-use the changelog section as release description, and the version as title.
Expand Down
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,25 +62,23 @@ dataspace technologies.

Our extension of EDC DataDashboard functionalities has been made open source and
will be kept compatible to mostly stock EDCs with minimal API extending
extensions. See [Compatibility](#compatibility).
extensions.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- COMPATIBILITY -->

## Compatibility

Our compatibility target for the profile `sovity-open-source` is our open-source
built
[ghcr.io/sovity/edc](https://github.com/sovity/edc-extensions/pkgs/container/edc)
by
[sovity/edc-extensions/blob/main/connector](https://github.com/sovity/edc-extensions/blob/main/connector).

See
https://github.com/sovity/edc-extensions/blob/main/connector/build.gradle.kts#L12
for a list of extensions used.
<div>
<div style="float:left;width:33%;">
<img src="docs/screenshots/screenshot-dashboard.png" style="max-width:300px;">
</div>
<div style="float:left;width:33%;">
<img src="docs/screenshots/screenshot-contracts.png" style="max-width:300px;">
</div>
<div style="float:left;width:33%;">
<img src="docs/screenshots/screenshot-assets.png" style="max-width:300px;">
</div>
</div>

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<br style="clear:both;"/>

<!-- GETTING STARTED -->

Expand Down
Binary file added docs/screenshots/screenshot-assets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/screenshot-contracts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/screenshot-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 17c24f9

Please sign in to comment.