The existing migration documents for Open Banking 2.0.0 to 3.0.0 [1] has several issues:
The content needs to be restructured for clarity. (For example: Need to move OB-related info into a separate .md file.)
Current OB migration documents heavily depend on the base product migration docs. This has caused several issues. i.e.,
We have instructed to skip certain steps in base product docs by only referring to the step numbers in them. But we noticed certain base product docs have been modified recently and this numbering has also been changed.
When referring to additional docs, we have mentioned the exact file name (in .md format) within the page to avoid confusion. But there is no such mechanism in the base product docs.
There is no any mechanism to track if the base product migration docs/resources get updated.
For a particular migration, there are many docs to refer.
One of the possible solutions:
Maintain all the docs inside the OB directory without referring to the base product docs even though it duplicates some content. Otherwise, there are too many docs to refer for a particular migration.
So going forward, we need to decide on a proper mechanism to solve these issues to avoid confusion and improve clarity.
Purpose
This issue is to track the $subject.
The existing migration documents for Open Banking 2.0.0 to 3.0.0 [1] has several issues:
.md
file.).md
format) within the page to avoid confusion. But there is no such mechanism in the base product docs.One of the possible solutions:
So going forward, we need to decide on a proper mechanism to solve these issues to avoid confusion and improve clarity.
References:
[1] https://github.com/wso2-enterprise/migration-docs/tree/main/open-banking/migration-docs/ob-2.0.0-to-3.0.0