Q: Where do I find documentation that helps me understand the big picture?
A: The following resources will help to understand the big picture:
- README - Introduction
- More information describing the big picture including the two main flows IRS Iterative and IRS Recursive and involved components and services.
Further information can be found in the IRS Architecture Documentation, for example:
- Architecture Documentation - Business Context
- Architecture Documentation - Structure
- Architecture Documentation - Building block view
- Architecture Documentation - Runtime view
Q: Where do I find the main documentation?
A: See Item Relationship Service Documentation.
Q: Is there a glossary?
A: Yes, see Item Relationship Service Documentation.
Q: Where do I get help?
A: Please read the documentation and tests first. If that does not answer your questions, ask the developers (see CONTACT).
Q: Are there any known issues and limitation?
A: See Known Issues and Limitations.
Q: Where can I report a vulnerability?
A: See SECURITY.
Q: Where can I report a bug?
A: Normal bugs may be reported as public github issues. For reporting vulnerabilities see SECURITY please.
Q: Where do I find information concerning compatibility of dependencies?
A: See COMPATIBILITY-MATRIX.
Q: How can I contribute?
A: See CONTRIBUTING.
Q: How do I create a release?
A: See CONTRIBUTING.
Q: How do I format the code?
A: See CONTRIBUTING.
Q: Where can I find more information concerning the type of tests and used technologies and libraries?
A: See README - Tests.
Q: Where do I find test data?
A: Testdata is located under local/testing/testdata. For more information see the test data README.
Q: Where do I find information concerning monitoring?
See README - Monitoring.