search

beckn / missions

This repo is solely created for the project management of the fide missions. the repo will be utilised for documentation purposes.
MIT License
4 stars 0 forks source link

Create Starter Kit #7

Closed faizmagic closed 2 months ago

faizmagic commented 2 months ago

Description

Create a generic starter kit that can be utilised by global programs team across missions and document the same in confluence. Please utilise ONEST starter pack as a reference

https://starterpack.onest.network/

TOC to be covered

  1. Introduction & Roles you can play - Mission specific a. Focus Areas b. Core Principles d. Roles you can Play
  2. NP Go-Live Checklist
  3. Onboarding Sandbox Registration a. Seeker Registration b. Provider Registration
  4. Network Observability - We will add this information once this is established a. Introduction b. Telemetry Implementation c. Dashboard Details

LEARN

  1. Beckn Protocol - Video Library
  2. Getting Started - Mission Specific, content will be generated from the Master Class
  3. Understanding the API's - same content to be fine tuned based on mission
  4. Beckn Implementation a. Getting Started i. introduction ii. explain about the various assets available iii. provide details of the assets, hardware / infra requirements iv. setup / deployment details b. Implementation i. Outcome Visualisation ii. Implementation Guide a. Provide details of the API' which needs to be implemented along with flow diagrams b. example jsons c. Schema Field Definitions and Enums d. Mandatory Fields e. Recommended Tags c. If you are a seeker application i. provide details on how to becknify a BAP application, explain this through a story ii. explain about the diff API's they need to implement ii. explain about the L2 config which needs to be applied iV. Integration testing using sandbox V. Integration testing using an actual Provider platform d. If you are a provider application i. provide details on how to becknify a BPP application, explain this through a story ii. explain about the diff API's they need to implement ii. explain about the L2 config which needs to be applied iV. Integration testing using sandbox V. Integration testing using an actual Provider platform e. Learning Path

COMMUNITY a. MISSION Protocol Specifications Working Group - Mission Specific b. Contribution Guide c. Community Events - Mission Specific d. Discussion Forum e. Discord Community

HELP a. FAQ b. Glossary

Goals

Expected Outcome

To have a start kit documentation which can be utilised by the global missions team across missions

vbabuEM commented 2 months ago

One version of this was reviewed on Tuesday. The following are the review comments:

  1. Separate static sections and mission specific sections, so that it will be easy to modify during missions
  2. Cite ONest in references section
  3. Write stories for Seeker Journey and Provider Journey
  4. Add samples for each artefact specific to missions cc @faizmagic
faizmagic commented 2 months ago

@vbabuEM , i have updated the description and TOC, please have a look. in most cases it is picked up from the ONEST starter kit, but i fine tuned the beckn implementation section. this section covers the implementation guide. other section are more for gyan.

vbabuEM commented 2 months ago

https://fide-official.atlassian.net/wiki/spaces/TPP/pages/494108721/Setting+up+a+new+Open+Network+using+Beckn

cc @faizmagic . We can go over this tomorrow.

vbabuEM commented 2 months ago

This task has been reviewed by Faiz. Marking this issue as done. Any changes will be part of another issue.

vbabuEM commented 2 months ago

The following is the location of the Starter Kit https://fide-official.atlassian.net/wiki/x/MYBzHQ