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

docs: improve readability of documentation #165

Merged
merged 7 commits into from
Dec 14, 2023
Merged

docs: improve readability of documentation #165

merged 7 commits into from
Dec 14, 2023

Conversation

MichaelSteinert
Copy link
Contributor

@MichaelSteinert MichaelSteinert commented Nov 21, 2023

What this PR changes/adds

This PR:

  • improves the readablity of documentation

  • fixes some typos

  • uses the logging webserver as docker container instead of JAR

  • makes use of docker container name instead of container id in streaming sample 2

  • removes non-working property maxDuration in streaming sample 2

  • makes use of docker compose instead fo docker-compose in advanced sample 1

  • adds missing catalog fetch in advanced sample 1

Closes #172
Closes #167

Copy link
Member

@ndr-brt ndr-brt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please create an issue as described in the contributing guide

Comment on lines 108 to 118
./gradlew util:http-request-logger:build
HTTP_SERVER_PORT=4000 java -jar util/http-request-logger/build/libs/http-request-logger.jar
docker build -t http-request-logger util/http-request-logger
docker run -p 4000:4000 http-request-logger
Copy link
Member

@ndr-brt ndr-brt Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why running it with docker should be better than running the jar directly

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First, I could not run this JAR after building it. Unfortunately, I could not fix this error:

Error: Could not find or load main class org.eclipse.edc.samples.util.HttpRequestLoggerServer
Caused by: java.lang.ClassNotFoundException: org.eclipse.edc.samples.util.HttpRequestLoggerServer

Secondly, there is a Dockerfile that is already used in other samples

Copy link
Member

@ndr-brt ndr-brt Nov 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like the jar task in the build.gradle.kts misses to include .class files in the jar:

from(sourceSets["main"].output)

with this addition to the jar task, it will work

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your help! Now running the JAR works. I have changed the use of container back to JAR.

@ndr-brt ndr-brt added the documentation Improvements or additions to documentation label Nov 22, 2023
@MichaelSteinert
Copy link
Contributor Author

MichaelSteinert commented Nov 22, 2023

Corresponding Issue #167

@paullatzelsperger paullatzelsperger removed their request for review November 27, 2023 06:28
Copy link

github-actions bot commented Dec 5, 2023

This pull request is stale because it has been open for 7 days with no activity.

@github-actions github-actions bot added the stale Open for x days with no activity label Dec 5, 2023
@github-actions github-actions bot removed the stale Open for x days with no activity label Dec 7, 2023
@ndr-brt
Copy link
Member

ndr-brt commented Dec 11, 2023

@MichaelSteinert could you take care of make the e2e tests pass? so we can merge then

@MichaelSteinert
Copy link
Contributor Author

MichaelSteinert commented Dec 13, 2023

@ndr-brt yes. i have fixed the e2e tests

Copy link
Member

@ndr-brt ndr-brt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@ndr-brt ndr-brt merged commit 543a5b4 into eclipse-edc:main Dec 14, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Management API version changed Enhancements to documentation functionality, readability and usability
2 participants