[
https://issues.apache.org/jira/browse/UNOMI-1010?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Serge Huber updated UNOMI-1010:
-------------------------------
Description:
h3. Summary
Some manual pages were not updated for 4.0:
* The shell commands page and the tutorial still use commands that no longer
exist.
* The configuration page presents the thirdparty settings as active in all
modes, and names the wrong header for the secret.
* No page explains the tenant settings that now control protected events:
restricted event types and authorized IP addresses.
* The condition validation page says that REST clients receive the validation
message. They receive a generic "badRequest".
* The profile tracking page says that an unknown tenant gives an error 401,
which is not what happens.
The goal of this ticket is that these pages match 4.0. The migration guide
itself is covered by UNOMI-1009.
h3. Ways to explore
* Replace the removed commands with unomi:crud examples.
* Move the thirdparty settings under compatibility mode, and add a section on
the tenant settings.
h3. How to test
Manual check: follow the tutorial on a fresh 4.0 install, check that every
command works, and review the listed pages.
Automated tests and checks to add:
* A shell integration test that runs the commands used in the tutorial and the
shell commands page, so a removed or renamed command is noticed.
* A REST test that checks the answer to a condition that fails validation, so
the documented answer stays true.
* A test that protected events follow the tenant settings for restricted event
types and authorized IP addresses, as the new section describes.
* The unknown tenant answer is tested in UNOMI-1008; the profile tracking page
must describe that tested behaviour.
was:
h3. Summary
Some manual pages were not updated for 4.0:
* The shell commands page and the tutorial still use commands that no longer
exist.
* The configuration page presents the thirdparty settings as active in all
modes, and names the wrong header for the secret.
* No page explains the tenant settings that now control protected events:
restricted event types and authorized IP addresses.
* The condition validation page says that REST clients receive the validation
message. They receive a generic "badRequest".
* The profile tracking page says that an unknown tenant gives an error 401,
which is not what happens.
The goal of this ticket is that these pages match 4.0. The migration guide
itself is covered by UNOMI-1009.
h3. Ways to explore
* Replace the removed commands with unomi:crud examples.
* Move the thirdparty settings under compatibility mode, and add a section on
the tenant settings.
h3. How to test
Follow the tutorial on a fresh 4.0 install, and check that every command works.
Review the listed pages.
> Some manual pages still describe Unomi 3.0 behaviour
> ----------------------------------------------------
>
> Key: UNOMI-1010
> URL: https://issues.apache.org/jira/browse/UNOMI-1010
> Project: Apache Unomi
> Issue Type: Task
> Reporter: Serge Huber
> Priority: Major
> Fix For: unomi-4.0.0
>
>
> h3. Summary
> Some manual pages were not updated for 4.0:
> * The shell commands page and the tutorial still use commands that no longer
> exist.
> * The configuration page presents the thirdparty settings as active in all
> modes, and names the wrong header for the secret.
> * No page explains the tenant settings that now control protected events:
> restricted event types and authorized IP addresses.
> * The condition validation page says that REST clients receive the validation
> message. They receive a generic "badRequest".
> * The profile tracking page says that an unknown tenant gives an error 401,
> which is not what happens.
> The goal of this ticket is that these pages match 4.0. The migration guide
> itself is covered by UNOMI-1009.
> h3. Ways to explore
> * Replace the removed commands with unomi:crud examples.
> * Move the thirdparty settings under compatibility mode, and add a section on
> the tenant settings.
> h3. How to test
> Manual check: follow the tutorial on a fresh 4.0 install, check that every
> command works, and review the listed pages.
> Automated tests and checks to add:
> * A shell integration test that runs the commands used in the tutorial and
> the shell commands page, so a removed or renamed command is noticed.
> * A REST test that checks the answer to a condition that fails validation, so
> the documented answer stays true.
> * A test that protected events follow the tenant settings for restricted
> event types and authorized IP addresses, as the new section describes.
> * The unknown tenant answer is tested in UNOMI-1008; the profile tracking
> page must describe that tested behaviour.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
