Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update maglionaire.md #401

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
108 changes: 108 additions & 0 deletions ChallangesAndQuests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# Flash Challenge and Connext Quests

The flash challenge is quality based, and the sumissions that are picked for this activity will receive rewards.

The Connext Quests are more complex and are not time based. How does it work?
> Note: ` You need to get approval for starting working on Connext Quests since we want to avoid duplication of work among participants. But Flash Challenges don't require approval `

1. Head out to "proposals" directory within this repository and create a .md file with your github handle, an example of a file would be: "fmanea.md".
The content of the file should contain the discord handle of the participant (or if it's a group of people working on a big feature, their discord handles). Also, the content of the file should contain any kind of proposal that you would want to build.
- Name of the quest you are applying for
- Describe what are you going to do in details
- Roadmap and milestones (if it's long-time project)
3. Send link with your PR in discord directly to "Mateip | bwarelabs.com#1629" or "Vladislav | p2p.org#8449". We will check if nobody has already done this quest, ask about realization if necessary, and approve starting of work
4. The Track Leaders will move the approved proposals into the "approved_proposals" folder where the progress will be tracked;


## ~~Flash Challenge 1 - Explore all guides, and gather them in one place in Docs~~ - DONE

1. Create Guides page in Docs https://docs.connext.network/routers/guides
2. Explore every guide written by other routers, group them by type (text/video), running way (AWS/Google/DO, Dedicated server, local home computer, kubernetes), language, etc. Links to the guides you can find here https://github.com/fmanea/ConnextRouterTrack/tree/main/submissions
3. Guides should be numbered
4. Brief overviews are welcome for those guides which have something special (highlight uniqueness)

## Flash Challenge 2 - Complete the routers documentation intro

Now we have "page no found" status, when we follow the link https://docs.connext.network/Routers/intro/

You should fix it - add detailed info on the following topics:
- who are routers
- why do we need them in Connext
- security assumptions and risks
- business model

The basic info is presented in the blog but it may be improved, You should review, figure out what information is missing

Github for PR https://github.com/connext/documentation

## Flash Challenge 3 - Propose a custody integration to improve the process for managing keys/liquidity

We are looking for the mechanisms to improve the process for managing keys/liquidity and make it more robust with minimum efforts right now (using a 3rd party custody solution as the recipient of the router liquidity)

Your proposal should include
- description of custody integration
- which projects are already use it?
- how it can improve the current process
- instruction/your experience how to set up it and use for managing keys/liquidity

## Quest 1 - Build Tools (10-500 points)

Build high impact tools to improve the router experience. We are waiting for your proposals:)

## Quest 2 - Quick router setup (10-500 points)

Router setup scripts for quick-running routers on cloud platforms and dedicated servers.

Examples:
- Setup based on any kind of scripting language (Ex: Bash Scripts,Python);
- Setup automate deployment using any kind of Infrastructure as a Code;(Ansible, Terraform or any other)
- Develop a router setup using npm or yarn instead of using docker-compose
- Develop a router setup using helm or any kind of kubernetes manifests



The goal would be a tool for running routers with just 1 click. Don’t hesitate to propose any tools which will simplify the process. Be creative, we are looking for different approaches.

Every submits needs a guide or documentation on how to use them, submitting without a doc we will be not taken into consideration.

## Quest 3 - Alerting system for Routers (10-500 points)

Create an alerting tool (telegram bot/slack/ etc.)

Examples:
- Integrate Alert Manager into the Docker Compose;
- Use Alert Manager to send alerts to Slack / Telegram/ Discord Channels;
- Use Grafana to send alerts on slack and integrate with a on-call tools

We are also open the new ideas, please feel free to propose any alerting approaches.

## Quest 4 - Monitoring tools for Routers (10-500 points)

Implement different monitoring deployments or dashboard for the router

Example:
- Use different tools for deploying an observability stack(Ex: ElasticSearch, Kibana, CloudWatch)
- Create Grafana dashboard

Our dream is to have different approches to monitor the router metrics and logs. Each router deployment can be easily integrate with any kind of infrastructure.

## Quest 5 - Integrade web3signer (10-100 points)

How to integrate web3signer with one of the cloud providers instead of using the key.yaml (aws secret manager, gcp secret manager, aws secrets, ansible vault, k8s etc.). + Bonus points for scripts(cloudformation, terraform, etc.). Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro

## Quest 6 - Best practices for generating and managing ssh-keys (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro


## Quest 7 - Hardening ssh config (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro


## Quest 8 - Hardening current docker-compose file (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro

## Quest 9 - How to create and use bastion instance for accessing routers infrastructure (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro



151 changes: 12 additions & 139 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@ The application process consists of several steps. **You** **must complete all o

# Router Track Proposals

Router Track participants will have the possibility to send proposals to build various tools for the Router community, that will improve the Router experience. Head out to "proposals" directory within this repository and create a .md file with your github handle, an example of a file would be: "fmanea.md".
Router Track participants will have the possibility to send proposals to build various tools for the Router community, that will improve the Router experience.

The content of the file should contain the discord handle of the participant (or if it's a group of people working on a big feature, their discord handles).
Also, the content of the file should contain any kind of proposal that you would want to build.
1. Head out to "proposals" directory within this repository and create a .md file with your github handle, an example of a file would be: "fmanea.md".The content of the file should contain the discord handle of the participant (or if it's a group of people working on a big feature, their discord handles).Also, the content of the file should contain any kind of proposal that you would want to build.
- What do you want to create in one sentence
- Why is it important? What's the value?
- Describe what are you going to do in details (more details - less questions from our side:))
- Roadmap and milestones (if it's long-time project)
2. Send link with your PR in discord directly to "Mateip | bwarelabs.com#1629" or "Vladislav | p2p.org#8449". We will check if nobody has already has similar proposal, ask about realization if necessary, and approve starting of work
3. The Track Leaders will move the approved proposals into the "approved_proposals" folder where the progress will be tracked;

> Note: `We will accept pull requests only if the .md file matches the github handle`

Expand All @@ -42,145 +47,13 @@ Also. all the submissions and work that a Router track participant has made shou

# Router Track Missions

Each week there will be some missions for the Router Track participants in which they will be rewarded with some points for delivering that activity.

### How to get maximum points?

Key evaluation criteria are quality (for docs/ guides/mentoring) and impact (for improvement proposals, feedback and tools). Connext should aim to be a self served platform also for routers, and we need to make sure documentations and guides serve this purpose.

## Router Track Mission 1 (09.05-16.05)

1. Spinning up a router on the testnet (10-30 points that depends on feedback /improvements proposals)
2. Choose the activity which you intend to work on over the course of the program (5 points)
3. Answer questions and help others to run router in this Discord channel (1-10 points)

## Router Track Mission 2 (16.05-23.05)

1. Video guide with a step-by-step running router in any language (5-100 points)
2. Guides and your experience articles about running router in socials (medium etc.) in any language (5-50 points)
3. Answer questions and help others to run router in this Discord channel (1-10 points)
4. Feedback/improvement proposals/building high impact tools (5-500 points)

## Router Track Mission 3 (23.05-30.05)
1. Testnet Upgrade - Add liquidity to the new contract (10-30 points)
2. Flash Challanges (10-100 points)
3. Router Connext Quests (10-500 points)

## Router Track Mission 4 (08.06-19.06) - note! you need to approve your proposal before starting work (Check Router Track Proposal Guide above)
1. Improve connext docs. We have a lot of good guides - now we need to improve official documentation quality. https://docs.connext.network/routers/intro (5-50 points)
2. Create your own quest. Don’t have enough time / skills to create tool or improvement? Just create a quest with your idea and get up to 100 points
https://forms.gle/qeeMyphU59TDxaWb7 (1-100 points)
3. Security quests (10 -100 points)
- How to integrate web3signer with one of the cloud providers instead of using the key.yaml (aws secret manager, gcp secret manager, aws secrets, ansible vault, k8s etc.) + Bonus points for scripts(cloudformation, terraform)
- Best practices for generating and managing ssh-keys
- Hardening ssh config
- Hardening current docker-compose file
- How to create and use bastion instance for accessing routers infr
Each week there will be some missions for the Router Track participants in which they will be rewarded with some points for delivering that activity. Key evaluation criteria are quality (for docs/ guides/mentoring) and impact (for improvement proposals, feedback and tools). Connext should aim to be a self served platform also for routers, and we need to make sure documentations and guides serve this purpose.

Check actual weekly mission here: https://github.com/fmanea/ConnextRouterTrack/blob/main/WeeklyMissions.md

# Flash Challange and Connext Quests

The flash challenge is quality based, and the sumissions that are picked for this activity will receive rewards.
The Connext Quests are more complex and are not time based. They require approval for starting working on it. How does it work?

1. Submit a proposal on this repository, in the "proposals" directory (Check Router Track Proposal Guide above). Propassal should include
- Name of the challenge/quest you are applying for
- Describe what are you going to do
- Roadmap and milestones (if it's long-time project)
3. Open a private thread in router-track discord channel and get approval for starting the work on this challange;
4. The Track Leaders will move the approved proposals into the "approved_proposals" folder where the progress will be tracked;


## ~~Flash Challenge 1 - Explore all guides, and gather them in one place in Docs~~ - DONE

1. Create Guides page in Docs https://docs.connext.network/routers/guides
2. Explore every guide written by other routers, group them by type (text/video), running way (AWS/Google/DO, Dedicated server, local home computer, kubernetes), language, etc. Links to the guides you can find here https://github.com/fmanea/ConnextRouterTrack/tree/main/submissions
3. Guides should be numbered
4. Brief overviews are welcome for those guides which have something special (highlight uniqueness)

## Flash Challenge 2 - Complete the routers documentation intro

Now we have "page no found" status, when we follow the link https://docs.connext.network/Routers/intro/

You should fix it - add detailed info on the following topics:
- who are routers
- why do we need them in Connext
- security assumptions and risks
- business model

The basic info is presented in the blog but it may be improved, You should review, figure out what information is missing

Github for PR https://github.com/connext/documentation

## Flash Challenge 3 - Propose a custody integration to improve the process for managing keys/liquidity

We are looking for the mechanisms to improve the process for managing keys/liquidity and make it more robust with minimum efforts right now (using a 3rd party custody solution as the recipient of the router liquidity)

Your proposal should include
- description of custody integration
- which projects are already use it?
- how it can improve the current process
- instruction/your experience how to set up it and use for managing keys/liquidity

## Quest 1 - Build Tools (10-500 points)

Build high impact tools to improve the router experience. We are waiting for your proposals:)

## Quest 2 - Quick router setup (10-500 points)

Router setup scripts for quick-running routers on cloud platforms and dedicated servers.

Examples:
- Setup based on any kind of scripting language (Ex: Bash Scripts,Python);
- Setup automate deployment using any kind of Infrastructure as a Code;(Ansible, Terraform or any other)
- Develop a router setup using npm or yarn instead of using docker-compose
- Develop a router setup using helm or any kind of kubernetes manifests



The goal would be a tool for running routers with just 1 click. Don’t hesitate to propose any tools which will simplify the process. Be creative, we are looking for different approaches.

Every submits needs a guide or documentation on how to use them, submitting without a doc we will be not taken into consideration.

## Quest 3 - Alerting system for Routers (10-500 points)

Create an alerting tool (telegram bot/slack/ etc.)

Examples:
- Integrate Alert Manager into the Docker Compose;
- Use Alert Manager to send alerts to Slack / Telegram/ Discord Channels;
- Use Grafana to send alerts on slack and integrate with a on-call tools

We are also open the new ideas, please feel free to propose any alerting approaches.

## Quest 4 - Monitoring tools for Routers (10-500 points)

Implement different monitoring deployments or dashboard for the router

Example:
- Use different tools for deploying an observability stack(Ex: ElasticSearch, Kibana, CloudWatch)
- Create Grafana dashboard

Our dream is to have different approches to monitor the router metrics and logs. Each router deployment can be easily integrate with any kind of infrastructure.

## Quest 5 - Integrade web3signer (10-100 points)

How to integrate web3signer with one of the cloud providers instead of using the key.yaml (aws secret manager, gcp secret manager, aws secrets, ansible vault, k8s etc.). + Bonus points for scripts(cloudformation, terraform, etc.). Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro

## Quest 6 - Best practices for generating and managing ssh-keys (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro


## Quest 7 - Hardening ssh config (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro


## Quest 8 - Hardening current docker-compose file (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro

## Quest 9 - How to create and use bastion instance for accessing routers infrastructure (10-30 points)
Note! You need submit a proposal before starting. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro



The Connext Quests are more complex and are not time based.

Check availiable challanges and quests here: https://github.com/fmanea/ConnextRouterTrack/blob/main/ChallangesAndQuests.md
38 changes: 38 additions & 0 deletions WeeklyMissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Router Track Missions

Each week there will be some missions for the Router Track participants in which they will be rewarded with some points for delivering that activity.

## How to get maximum points?

Key evaluation criteria are quality (for docs/ guides/mentoring) and impact (for improvement proposals, feedback and tools). Connext should aim to be a self served platform also for routers, and we need to make sure documentations and guides serve this purpose.

## ~~Router Track Mission 1 (09.05-16.05)~~

1. Spinning up a router on the testnet (10-30 points that depends on feedback /improvements proposals)
2. Choose the activity which you intend to work on over the course of the program (5 points)
3. Answer questions and help others to run router in this Discord channel (1-10 points)

## ~~Router Track Mission 2 (16.05-23.05)~~

1. Video guide with a step-by-step running router in any language (5-100 points)
2. Guides and your experience articles about running router in socials (medium etc.) in any language (5-50 points)
3. Answer questions and help others to run router in this Discord channel (1-10 points)
4. Feedback/improvement proposals/building high impact tools (5-500 points)

## ~~Router Track Mission 3 (23.05-30.05)~~
1. Testnet Upgrade - Add liquidity to the new contract (10-30 points)
2. Flash Challanges (10-100 points)
3. Router Connext Quests (10-500 points)

## Router Track Mission 4 (08.06-19.06)

1. Improve connext docs. We have a lot of good guides - now we need to improve official documentation quality. Expected result is PR with edit in connext docs https://docs.connext.network/routers/intro (5-50 points)
2. Create your own quest. Don’t have enough time / skills to create tool or improvement? Just create a quest with your idea and get up to 100 points
https://forms.gle/qeeMyphU59TDxaWb7 (1-100 points)
3. Security quests. You can find links for the quests below. Expected result is PR with edit in connext docs https://docs.connext.network/routers/security (10 -100 points)
> note! you need to approve your proposal before starting work with quests - [Check proposal's Guide here](https://github.com/fmanea/ConnextRouterTrack#router-track-proposals)
- [Quest 5](https://github.com/fmanea/ConnextRouterTrack/blob/main/ChallangesAndQuests.md#quest-5---integrade-web3signer-10-100-points) How to integrate web3signer with one of the cloud providers instead of using the key.yaml (aws secret manager, gcp secret manager, aws secrets, ansible vault, k8s etc.) + Bonus points for scripts(cloudformation, terraform)
- [Quest 6](https://github.com/fmanea/ConnextRouterTrack/blob/main/ChallangesAndQuests.md#quest-6---best-practices-for-generating-and-managing-ssh-keys-10-30-points) Best practices for generating and managing ssh-keys
- [Quest 7](https://github.com/fmanea/ConnextRouterTrack/blob/main/ChallangesAndQuests.md#quest-7---hardening-ssh-config-10-30-points) Hardening ssh config
- [Quest 8](https://github.com/fmanea/ConnextRouterTrack/blob/main/ChallangesAndQuests.md#quest-8---hardening-current-docker-compose-file-10-30-points) Hardening current docker-compose file
- [Quest 9](https://github.com/fmanea/ConnextRouterTrack/blob/main/ChallangesAndQuests.md#quest-9---how-to-create-and-use-bastion-instance-for-accessing-routers-infrastructure-10-30-points) How to create and use bastion instance for accessing routers infr
Loading