# Contributions report

In this report, we will briefly go over the specific issues we have resolved and the issues we looked at and worked on but that did not result in a pull request.

We are aware that we have a very limited number of contributions and the contributions we did make are not significant. We would like to explain why it is so low and show we did try our best.

The course provided by Egeria (Dojo) learns beginners to install the system, get everything running and familiarize themselves with the software. This "Dojo" already required 4 full workdays (32 hours). On top of that, there is another course on contributing, which also required a full workday. Most of us did manage to get through most of these course days, but this has cost us a lot of time.

We went through every issue on the git, searching for issues that were doable for us to tackle. There was only one issue labelled as "for beginners", which we started on but could not be finished as explained below in issue 5088. The rest of the issues either required in-depth knowledge of Egeria, or be experienced in software like Docker, Kubernetes, or Gradle.

This was an even bigger problem for us as we were not familiar in all these subjects. We were out of our depth with the size and complexity of the system made we were just not able to pick up more relevant issues.

To still try to get an idea of the system and how it is being developed, as well as to gain some experience with the system and possible issues to work on; We did join several developer and community meetings where developers discussed concepts and developments surrouding Egeria. Those meetings were really interesting and provided some key insights which were useful for the essays. However, it also emphasized Egeria to be a complicated and complex system.

## Resolved issues
These are issues we have looked at and created pull requests for.

**Typo in practices documentation page**
Issue: https://github.com/odpi/egeria-docs/issues/356
Pull request: https://github.com/odpi/egeria-docs/pull/357

Found a spelling mistake on a documentation page of Egeria. Consequently, we corrected this mistake and created a pull request, which was merged the same day.

**Dead URL link in education page**
Issue: https://github.com/odpi/egeria-docs/issues/385
Pull request: https://github.com/odpi/egeria-docs/pull/390

In the educational documents of Egeria, there were installation links to URLs that did not exist. We corrected the links and added additional links for OS-specific systems.

## Unresolved issues
These are issues we looked at but did not end up creating a pull request for.

**'too many open files' running FVT - add recommendation on configuration**
Issue: https://github.com/odpi/egeria/issues/5088

This issue was at the start of the project the only open issue that had the tag: good first issue. We reached out to the maintainers inquiring about the issue and whether it was still relevant as it had been open for almost a year. One of the maintainers informed us that they didn't know if the issue persisted as Windows is not commonly used. During our runs through the examples, we did not run into this issue as the tests required a server setup that we didn't have locally. The issue was later closed due to other issues being opened which this would fall under.

**Gradle deprecations - tasks, archives, Jcenter**
Issue: https://github.com/odpi/egeria/issues/6109
The issue contained very little information regarding what went wrong in the Gradle deprecation. None of us has had a lot of experience in using Gradle, so some of us started on the issue by first understanding the Gradle functionality. When we wanted to reach out, one of the developers had already said they fixed it.

<!-- **...**
Issue: https://github.com/odpi/egeria/issues/6151
Bas
-->

**configure docker image - script error checking**
Issue: https://github.com/odpi/egeria/issues/5956

When running the configure image command without proper parameters. There is currently no clear feedback on what went wrong. This could be fixed by adding better error checking and/or messages. We however ran into some problems with using docker, and since none of us had experience using this we weren't able to get the setup correct to where we could replicate the issue.

**Fix deprecation warnings across Egeria components**
Issue: https://github.com/odpi/egeria/issues/5363
For this issue, we looked at this as it seemed like it would be easy to add the warning suppressions. However, only a minority of these deprecated functions were intentional. What was and wasn't intentionally deprecated to support old APIs thus it was difficult for us to judge what we should change (and to what newer functions) and what to suppress. Eventually, we decided to focus on other issues.

# Egeria PR midway report

In this report we will briefly go over the specific issues we have resolved and the issues we are planning to tackle. So far we have only worked on relatively smaller issues, but identified some interesting ones we plan to work in the last part of the course.

## Resolved issues
These are issues we have looked at and created a pull request for.

**Typo in practices documentation page**
Issue: https://github.com/odpi/egeria-docs/issues/356
Pull request: https://github.com/odpi/egeria-docs/pull/357

Up until this point we have created one issue regarding a spelling mistake on a documention page of Egeria. Consequently we corrected this mistake and created a pull request, which was merged the same day.

## Open / planned issues
This is a list of issues we have looked at but not yet resulted in a merge-request, since the start of the course we now feel more confident in our ability with Egeria and work on these issues in the next 2 weeks.

**Broken links in the open metadata lab**
Issue: https://github.com/odpi/egeria/issues/6151

The issue concerns not yet defined links which do not appear to link to anything. This is a relative easy issue to fix as it concerns an broken link in one of the educational documentations. We will investigate which links do not work and will try to fix as many as possible. This will give a great excercise to contribute for the team members that have not yet contributed.

**Tests should check for no unexpected exceptions (ie on server)**
Issue: https://github.com/odpi/egeria/issues/3414

It was noted that a PR caused unexpected errors to be added into the server's audit logs due to incorrect processing.
The automated FVT test for subject area did not pick this up -- since the test still worked fine as far as the subject area API was concerned.
We need to consider how to address this kind of issue in automated testing. It may be that FVTs or integration tests do need to check for unexpected audit events as part of their verification.

This is already a more advanced issue to resolved for us, but should be doable as it concerns additional test cases.

**Too many open files' running FVT - add recommendation on configuration**
Issue: https://github.com/odpi/egeria/issues/5088#

The cause is, as can be seem, 'too many open files'.
We should add a reference in the docs to suggest the user may need to increase the max number of open files (though the details on doing this, and in particular making it persistent, vary by the exact OS flavour. Exact docs on how to do this for each distribution is best outsourced to google due to the variety of options. Following this change egeria can be built in its entirety including fvt.