project icon indicating copy to clipboard operation
project copied to clipboard
verified publisher icon mojaloop

placeholder issue for broken links with the new documentation restructuring, v3 docs

Open elnyry-sam-k opened this issue 1 year ago • 7 comments

Summary: The issue here is a place to report any broken links and during the first two weeks of the v3 restructuring on docs.mojaloo.io, we'll ensure these are addressed with priority for the next two weeks.

Severity: (Low, Medium, High)

Priority: (Critical, Medium, Low)

Expected Behavior Links should work or should be updated / removed

Steps to Reproduce 1. 2. 3.

Specifications

  • Component (if known): Documentation - https://docs.mojaloop.io/
  • Version: v3
  • Platform:
  • Subsystem:
  • Type of testing:
  • Bug found/raised by:

Notes:

  • Severity when opened:
  • Priority when opened:

elnyry-sam-k avatar Nov 15 '24 09:11 elnyry-sam-k

@elnyry-sam-k I'm checking the Technical page within the documentation. The formatted text in this ticket is the text containing the link, the link is the actual broken link. Let me know if I could format this differently or elsewhere like create a new issue for this. cc @simeonoriko

Broken links found per section:

Deployment Guide -> Deploying Mojaloop -> Deployment and Setup:

  • [ ] 4. Helm -> Mojaloop Helm Chart https://docs.mojaloop.io/technical/technical/repositories/helm.html
  • [ ] 5.4 Testing Mojaloop -> Mojaloop Testing Toolkit https://docs.mojaloop.io/technical/documentation/mojaloop-technical-overview/ml-testing-toolkit/
  • [ ] 5.4.1 Mojaloop Testing Toolkit https://docs.mojaloop.io/technical/documentation/mojaloop-technical-overview/ml-testing-toolkit/
  • [ ] 5.4.2 Mojaloop Testing Toolkit Documentation https://docs.mojaloop.io/technical/documentation/mojaloop-technical-overview/ml-testing-toolkit/
  • [ ] 5.5 Mojaloop Testing Toolkit https://docs.mojaloop.io/technical/documentation/mojaloop-technical-overview/ml-testing-toolkit/
  • [ ] 5.5 Automated Testing Guide https://docs.mojaloop.io/technical/technical/contributors-guide/tools-and-technologies/automated-testing.html
  • [ ] 6 Overlay Services -> 3rd Party Account Linking https://sandbox.mojaloop.io/usecases/3ppi-account-linking.html
  • [ ] 6 Overlay Services -> 3rd Party Initiated Payments https://sandbox.mojaloop.io/usecases/3ppi-transfer.html

Deployment Troubleshooting

  1. Known Issues
  • [ ] Mojaloop v12.0.0 values config https://github.com/jaloop/helm/blob/v12.0.0/mojaloop/values.yaml

theobadha avatar Nov 20 '24 12:11 theobadha

Account Lookup Service -> 5. Database Design

  • [ ] Mojaloop 1.1 Specification https://docs.mojaloop.io/technical/technical/account-lookup-service/api
  • [ ] Account Lookup Service DBeaver ERD https://docs.mojaloop.io/technical/technical/account-lookup-service/assets/entities/AccountLookupDB-schema-DBeaver.erd
  • [ ] Account Lookup Service MySQL Workbench Export https://docs.mojaloop.io/technical/technical/account-lookup-service/assets/entities/AccountLookup-ddl-MySQLWorkbench.sql

theobadha avatar Nov 21 '24 08:11 theobadha

Central Event Processor Service -> Notification Handler for Rejections -> References within Sequence Diagram

  • [ ] Event Handler Consume (9.1.0) https://docs.mojaloop.io/technical/technical/central-event-processor/9.1.0-event-handler-placeholder.html
  • [ ] Sequence Diagram - missing

theobadha avatar Nov 21 '24 09:11 theobadha

Reference Architecture -> Bounded Contexts -> Reporting -> Absolutely minimum rules to observe

  • [ ] Interop APIs https://docs.mojaloop.io/refarch/boundedContexts/fspInteropApi/

theobadha avatar Nov 21 '24 11:11 theobadha

FSPIOP API -> API Definitions -> v1.1(Current) -> Introduction -> Open API for FSP Interoperability Specification Logical Documents

  • [ ] Logical Data Model https://docs.mojaloop.io/technical/api/fspiop/logical-data-model
  • [ ] Generic Transaction Patterns https://docs.mojaloop.io/technical/api/fspiop/generic-transaction-patterns
  • [ ] Use Cases https://docs.mojaloop.io/technical/api/fspiop/use-cases

Asynchronous REST Binding Documents

  • [ ] API Definition https://docs.mojaloop.io/technical/api/fspiop/definitions
  • [ ] JSON Binding Rules (https://docs.mojaloop.io/technical/api/fspiop/json-binding-rules
  • [ ] Scheme Rules https://docs.mojaloop.io/technical/api/fspiop/scheme-rules

Data Integrity, Confidentiality, and Non-Repudiation

  • [ ] PKI Best Practices https://docs.mojaloop.io/technical/api/fspiop/pki-best-practices
  • [ ] Signature https://docs.mojaloop.io/technical/api/fspiop/v1.1/signature
  • [ ] Encryption https://docs.mojaloop.io/technical/api/fspiop/v1.1/encryption

General Documents

  • [ ] Glossary https://docs.mojaloop.io/technical/api/fspiop/glossary

theobadha avatar Nov 21 '24 13:11 theobadha

FSPIOP API -> API Definitions -> v1.1(Current) -> Generic Transaction Patterns Binding

  • [ ] Generic Transaction Patterns https://docs.mojaloop.io/technical/api/fspiop/generic-transaction-patterns

theobadha avatar Nov 21 '24 13:11 theobadha

FSPIOP API -> Logical Data Model -> Introduction -> Open API for FSP Interoperability Specification Logical Documents

  • [ ] Generic Transaction Patterns https://docs.mojaloop.io/technical/api/fspiop/generic-transaction-patterns
  • [ ] Use Cases https://docs.mojaloop.io/technical/api/fspiop/use-cases

Asynchronous REST Binding Documents

  • [ ] API Definition https://docs.mojaloop.io/technical/api/fspiop/api-definition
  • [ ] JSON Binding Rules https://docs.mojaloop.io/technical/api/fspiop/json-binding-rules
  • [ ] Scheme Rules https://docs.mojaloop.io/technical/api/fspiop/scheme-rules

Data Integrity, Confidentiality, and Non-Repudiation

  • [ ] PKI Best Practices https://docs.mojaloop.io/technical/api/fspiop/pki-best-practices
  • [ ] Signature https://docs.mojaloop.io/technical/api/fspiop/v1.1/signature
  • [ ] Encryption https://docs.mojaloop.io/technical/api/fspiop/v1.1/encryption

General Documents

  • [ ] Glossary https://docs.mojaloop.io/technical/api/fspiop/glossary

theobadha avatar Nov 21 '24 14:11 theobadha