|
|
| Status | Description |
|
|
|
| --- | --- |
|
|
|
Paused | We are in the process of revamping PyMemri. We're halting all plugin development until it's ready. Projected for the end of August 2021.
|
|
|
|
|
|
|
|
|
### Welcome to Memri!
|
|
|
|
|
|
This quickstart will teach you the basics of our products, how to build plug-ins in python as well as how to get them reviewed and published. As we go through the process of developing plug-ins, we will explain our approach to building a safe and secure storage space for a user's data needs.
|
|
|
|
|
|
Memri was founded on the realization that ELABORATE. That's why we build our tech stack with developers in mind, but developers are humans too! So our design approach is to make the development of plug-ins user friendly for programmers of all backgrounds.
|
|
|
|
|
|
---
|
|
|
|
|
|
Plugin Developers are the core members of our community. We're glad to have you onboard. Make sure you've connected with our Community Liaison to go through the onboarding call.
|
|
|
|
|
|
**Step 1: Getting started**
|
|
|
|
|
|
Check out our *[Getting started building a plug-in blog post*](https://blog.memri.io/getting-started-building-a-plugin/) to start. This will guide you through the installation and development phases that you'll need to get up and running.
|
|
|
|
|
|
**Step 2: Join our [Discord](https://discord.com/invite/NUQSRFkKwv)**
|
|
|
|
|
|
When you are starting building plugins you'll likely have many questions. Please join our [discord](https://discord.com/invite/NUQSRFkKwv) and ask those questions to our community and the Memri engineers. We look forward to help you out and work together towards giving people back control over their data!
|
|
|
|
|
|
**Step 3: Sign up for the [Memri GitLab](https://gitlab.memri.io/)**
|
|
|
|
|
|
Remember to register to our [Memri GitLab](https://gitlab.memri.io/), where our Community Liaison will create a GitLab repo for your new plug-in and add you as a maintainer.
|
|
|
|
|
|
**Step 4: Onboarding and Point of Contact Assignment**
|
|
|
|
|
|
To welcome you to the community, you'll be invited to join an onboarding call hosted by our Community Liaison. During this call, you will be provided with all of the relevant information and resources you'll need to succeed as a part of our community. **We will connect you with a member of our team to be your point of contact through the development process.**
|
|
|
|
|
|
**Step 5: Building a plug-in**
|
|
|
|
|
|
Add in details from confirmed process page.
|
|
|
|
|
|
**Step 6: Authentication Process**
|
|
|
|
|
|
After you've gone through the set up via onboarding, you can start installing the POD and creating your plugin. Our Community Liaison will create a GitLab repo for your new plugin and add you as maintainer.
|
|
|
|
|
|
When you start your plugin make sure to get approval for the schema from a Schema Maintainer by creating a Merge Request(MR) to the [Schema Repository](https://gitlab.memri.io/memri/schema). When you are ready with your plugin it must go through our review process conducted by a Plugin Reviewer to evaluate the quality of your plugin. Make sure to issue an MR against a first empty commit to make it easy to have all your code reviewed.
|
|
|
|
|
|
Our community Liaison will connect you with the relevant Schema Maintainer and Plugin Reviewer. Once your plugin has been reviewed and approved, our Community Liaison will approve the bounty payment.
|
|
|
|
|
|
**Important!**
|
|
|
|
|
|
Make sure you are in contact with the [Community Liaison](https://gitlab.memri.io/memri/memri/-/wikis/Community-Liaison-Role) at least once every two weeks. Otherwise you'll run the risk of someone else taking over your plugin. |
|
|
\ No newline at end of file |