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

Enhancements to documentation functionality, readability and usability #167

Closed
MichaelSteinert opened this issue Nov 22, 2023 · 2 comments · Fixed by #165
Closed

Enhancements to documentation functionality, readability and usability #167

MichaelSteinert opened this issue Nov 22, 2023 · 2 comments · Fixed by #165
Labels
stale Open for x days with no activity

Comments

@MichaelSteinert
Copy link
Contributor

Adoption in EDC samples

Why should this contribution be adopted?

The samples are to be made functional again. Current problems are:

  • use of docker-compose in advanced sample 1
  • missing of catalog fetch in advanced sample 1
  • use of non-working property maxDuration in sample 2

Further usability improvements would be:

  • use of container name instead of container id in streaming sample 2
  • use of the logging webserver as docker container instead of JAR

These enhancements improve the usability and readability of the documentation, making it more accessible to new contributors.

Could it be achieved with existing functionality? If not, why?

Some of these improvements, such as typo fixes and readability enhancements, are straightforward and cannot be achieved with existing functionalities.

Would this feature limit platform independence in any way? If so, how and why?

No, these changes will not limit platform independence.

Is it going to be a self-contained feature, or would it cut across the entire code base?

The changes are self-contained, mostly affecting documentation. They are not expected to impact the broader code base or its stability.

Copy link

Thanks for your contribution 🔥 We will take a look asap 🚀

Copy link

github-actions bot commented Dec 7, 2023

This issue is stale because it has been open for 14 days with no activity.

@github-actions github-actions bot added the stale Open for x days with no activity label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Open for x days with no activity
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant