-
Notifications
You must be signed in to change notification settings - Fork 46
Open
Labels
documentationImprovements or additions to the documentation.Improvements or additions to the documentation.good first issueGood for newcomers.Good for newcomers.
Description
Description
The documentation about test rules page does not contain information that it is not meant for production. This is only mentioned in back-end and when you start up EI front-end.
The example images are outdated and the aggregation does not match how it is stored in the database. We no longer store it with the key "aggregatedObject" but instead keep the aggregation on root level in the MongoDB document. This should be updated with a new example.
The image with Eiffel events contains old templates (they have Toulouse version of Eiffel protocol). This can also be updated at the same time by using Agen version events.
Motivation
Correct example avoids any confusion.
Exemplification
- https://github.com/eiffel-community/eiffel-intelligence-frontend/blob/master/wiki/test-rules.md should be updated.
- Switch out the image of the resulting aggregation. Double check the other images also.
- Write a short sentence that this page should not be enabled in a production environment.
- Start up Eiffel Intelligence with test.aggregation.enabled: true and test some rules to get updated examples to use in documentation.
Benefits
Up-to-date documentation.
Possible Drawbacks
None.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to the documentation.Improvements or additions to the documentation.good first issueGood for newcomers.Good for newcomers.