By continuing to navigate you agree to allow cookies to be placed. You can learn how to change your preferences here.

Got it
Self-service is here! Launch Syntropy Stack

Syntropy Builders Guidelines

Version: v.2.0

Latest Update: 2021-03-10


All kinds of contributions are welcome and necessary to our success as we move forward with the project. This is your opportunity to get involved in Syntropy Stack development and learn new skills in the process. 

To help you get started, we've prepared you a list of projects, which you will find in Builders Page or dedicated Google Sheet. As we progress, we will be adding new projects and updating you on #community-involvement channel on Discord as we do so. 

New ideas are welcome and encouraged. If you want to propose your own project, please do so on #community-involvement channel on Discord.


Registration

You will see whether someone has been assigned or completed the project in the Projects Sheet.

Every time we update the list of projects, we will announce it on the #community-involvement channel on Discord.

If you want to apply to a specific project, you will need to fill in the dedicated form.

You can apply to more than one project at once, but we will split the workload evenly among those who apply. We will decide who to assign to each project according to our internal guidelines and inform you personally.

Complete registration does not mean that you are assigned for the task! 

When your application is approved, we will invite you to join the corresponding working group channel and say hello to the Group Lead(s).

Working Groups

Each project is always assigned to a working group. Working groups are comprised of individual developers or teams working on specific projects. Working groups are here to facilitate the collaborative nature of the project. Ask questions if you have stumbled upon an obstacle and lend a hand for those in need.

Each working group is assigned a channel for all related discussions. 

The purpose of these channels is to keep all communication public so that:

  1. All information would be readily available to others who might join the working group at a later stage.
  2. Group Leads could better manage communications with developers.
  3. Other developers working on similar projects would be able to help you with any obstacles you are having or provide feedback. 

Working group channels are visible to all, but only those currently involved in a project, those involved in the past, Group Leads and other Syntropy employees can participate in discussions.

Group Lead

Group lead is your main point of contact if you need additional information, materials, assets, or just want to ask a question. Working groups can have more than one group lead. The one assigned to your project is responsible for validating and approving your work. Compensation is only distributed once the group lead deems the project as completed. We highly encourage you to use dedicated working group channels for all communications with your group lead and refrain from using private messages.

Projects

Each project has a unique ID, which you will need to select in your application. We will use the ID to refer to the specific project if there is such a need and encourage you to do so too.

Always check the full documentation of the project where you will find a complete description and requirements.

There are different types of projects, e.g. integrations, case studies and contributions. As we move forward and add new types of projects, we will update the guidelines.

Integration

Blockchain

Blockchain integrations help facilitate the node deployment process by pre-writing  necessary automation scripts. Integrations allow node operators to automatically orchestrate the needed infrastructure and configure monitoring solution. This simplifies deployment and management for existing node operators, but also makes it easier for non-technical audiences.

Gaming

Gaming integrations help facilitate the adoption of Syntropy technology by allowing gamers and hosting services to spin-up secure and performance-optimized experiences more easily and quickly. 

Case Study

Case studies are intended to leverage Syntropy Stack's existing functionality to develop new use-cases for the technology, facilitate future deployments and guide other developers. 

Contribution

Contribution projects are intended to extend the functionality of Syntropy Stack.

General Project Requirements

For the project to be considered as completed:

Submitting a GitHub Repository

To submit your work please follow the following steps: 

DevOps projects:

https://github.com/SyntropyNet/syntropy-devops-integrations 

Blockchain integrations:

https://github.com/SyntropyNet/syntropy-blockchain-integrations

Gaming integrations:

https://github.com/SyntropyNet/syntropy-gaming-integrations

Writing a Good Readme

Each submitted GitHub repository has to include a concise and detailed Readme of the project. 

You will find quality examples and articles on how to write a good Readme here:

https://github.com/matiassingers/awesome-readme 

If you feel like improving your technical writing, Google has a fantastic course on the subject:

https://developers.google.com/tech-writing/overview 

Bonus Tasks

Some projects include bonus tasks, such as writing a blog post.

There are different types of bonus tasks. Find information below.

Tutorial / Blog

For this task, you will be writing a tutorial for a blog post. The tutorial has to be written in clear and concise English.

It has to be uploaded to medium.com and dev.to. If you wish, you can also upload it to your blog or other sites of your choice (e.g. Hacker News, Hacker Noon, Reddit, etc.). 

Imagine that you are a developer trying to achieve the same result you've just done by completing the main task. Write a tutorial for him/her. Make sure to include all major steps, code snippets, screenshots and whatever information you deem necessary.

You don't have to detail steps that are highly specific to other tools (e.g. setting up Digital Ocean Droplet). Assume that your reader has some experience in using the tools that you use in your tutorial. However, if it's something more complicated, please include a link to a relevant tutorial. Use common sense and try to strike the right balance. Found something to be more difficult than you expected? You probably read a tutorial on that. Put the link in your own tutorial.

A tutorial is not readme!

Make sure to include a brief introduction of what is the end goal of the tutorial. Also, have a conclusion. Ideally, think about how this can help the average developer. How does this come into play in real-world scenarios, and how do you envision Syntropy Stack being used in these applications?

It's imperative to keep in mind that the broader audience might be unaware of Syntropy Stack. When writing a tutorial, always include a description of what Syntropy Stack is. You can use and expand the description below, but try to explain it in your own words.  

Syntropy Stack is a selection of applications and tools that enables you to set up secure connectivity across all endpoints quickly. You can connect any service and device running on a cloud, on-premise, and edge infrastructure. If you need to connect thousands of endpoints, you can do so using Syntropy software agent in combination with container-orchestration systems like Kubernetes and configuration tools like Ansible. 

If you see fit, try to explain why you use Syntropy Stack to do one thing or another in a tutorial.

Writing a tutorial is a lot easier while you are in the process of doing the main task. That's why we usually make this bonus task required to be completed together with your main task.

Once you are done with the tutorial, it has to be approved by your Group Lead. 

Also, feel free to share it wherever you like!

Screen Recording

For this task, you will be creating a screen recording. We recommend using Loom, but you can choose any software you like.

If you've also written a tutorial, make sure to attach this recording to that publication. If not, make sure to upload it to your chosen platform (e.g. Twitter, Youtube, dev.to). One upload is required, but feel free to upload it to more than one platform.

Imagine that you are a developer trying to achieve the same result you've just done by completing the main task. Make a screen recording for him/her. Make sure to include all major steps and whatever information you deem necessary.

English voiceover describing your workflow is required. In some special cases, voiceover might be replaced with subtitles or captions, but you have to consult us beforehand. If you can't record a voiceover for any reason, you can collaborate with another person.

GitHub Actions Pipeline

For this task, you will be creating a Github Actions pipeline, which will run whenever someone pushes a new commit to the main branch.

Write job steps to all manual executed actions, like:

The last step must be a test to check if everything is deployed correctly.

Project Submission

Once you complete your project, use this form to submit it:

Projects Submission

Our tech and marketing teams will check it as soon as possible.

Compensation

In the projects sheet, you will see the USD worth of compensation for each completed project. The compensation is based on the difficulty of the project and the time required to complete it. Payments will be made in an equivalent amount of $NOIA tokens to the compensation's USD value. The exact amount of tokens is calculated at the very moment we send you the rewards. When we distribute tokens depends on the gas price, but we do that as soon as possible after the task is marked as completed. You will be eligible for compensation only after the project is completed, and the responsible person validates it. Once it's done, please send the wallet address to which you wish to your group lead.

Teamwork

We have determined how many people are required to complete each project. If you believe that the number is too low or too high, you can shoot us a message, and we will reevaluate. However, keep in mind that the compensation pool is a fixed amount per project. 

Deadlines

Deadlines are not always specified in a project sheet. In most cases, we will agree on a deadline before you commit to the project. If you feel that you won't be able to finish the project until the deadline, let us know beforehand. Each case is different, so most importantly, communicate. 

Useful Links


Projects Sheet


Application Form


Task Submission form