What is your capability to deliver your project with high levels of trust and accountability?
Our team has a proven capability to deliver projects with high levels of trust and accountability. With over 75 years of collective experience in programming and system administration, our developers have a strong track record of successfully creating similar tools for other businesses in the past. We have already developed a functioning tool that has been actively used internally since September 2021, demonstrating our commitment to creating reliable and effective solutions.
By open-sourcing this tool, we aim to enhance its accessibility and usability for new users. To ensure trust and accountability, we will clean up, refactor, and document the code so it is better suited to public use and consumption. We will actively engage with the open-source SPO community, providing clear documentation, issue tracking, and contribution guidelines to foster transparency and collaboration. With our expertise, dedication, and proactive approach to maintaining the project, we are confident in our capability to deliver a high-quality open-source solution with utmost trust and accountability.
What are the main goals for the project and how will you validate if your approach is feasible?
The main goal of this project is to Open Source a tool that we have developed in-house and used successfully for the past 2 years to help us manage our Cardano Node instances and network. In order to Open Source in a manner that is most useful to the community, we will engage in the following steps:
- Review and Refactor: Take some time to review the existing codebase and identify areas that can be improved. We will refactor the code where needed to ensure it follows best practices, is well-organized, and adheres to the coding guidelines that we have established.
- Documentation: We will document the purpose and overall functionality of the project. This will include an overview, installation instructions, configuration details, and any prerequisites. We will provide clear instructions on how to use the tool, including examples and sample code where relevant.
- Readme File: We will provide a comprehensive README file that serves as a landing page for this tool. This will include an introduction, an overview of the tool’s features, installation instructions, usage examples, and any other relevant information. We believe that a well-written README is crucial for attracting and engaging potential users and contributors.
- Issue Tracking: We will set up an issue tracking system, using GitHub Issues, to allow users and contributors to report bugs, suggest features, or ask questions. We will encourage SPOs to provide feedback and participate in the development process.
- Licensing: We will use the MIT License.
- Version Control: This tool is already being maintained in a Git repository. We will open this up to the public after our cleanup and documentation is completed.
- Contribution Guidelines: We will define contribution guidelines and provide instructions on how SPOs and developers can contribute to this tool. This will include guidelines on submitting bug reports, feature requests, and pull requests.
By conducting a thorough evaluation of the existing tool, implementing code improvements, enhancing documentation, and incorporating user feedback, we will be able to validate the feasibility of our approach. These steps will ensure that our goals of open-sourcing the project and making it more accessible to new users are achievable.
Please provide a detailed breakdown of your project’s milestones and each of the main tasks or activities to reach the milestone plus the expected timeline for the delivery.
1 Project Plan – this is what you are reading right now
2 Basic Project Structure – a python script that is the foundation for the tool
3 Network Model + Terraform – ability to create and destroy nodes
4 Remote code execution and basic node configuration – deploy config to nodes, create & manage user accounts, credentials distribution
5 VPN – increase communication of all nodes by having network traffic use a VPN tunnel between each of the nodes
6 Node Type: Admin – ability to create, configure and manage an admin node
7 Node Type: Relay – ability to create, configure and manage a relay node
8 Node Type: Producer – ability to create, configure and manage a producer node
9 Documentation – detailed documentation for milestones 2-8
10 Close-out Report
Please describe the deliverables, outputs and intended outcomes of each milestone.
1 Project Plan – this is what you are reading right now
2 Basic Project Structure – a python script that is the foundation for the tool
3 Network Model + Terraform – ability to create and destroy nodes
4 Remote code execution and basic node configuration – deploy config to nodes, create & manage user accounts, credentials distribution
5 VPN – increase communication of all nodes by having network traffic use a VPN tunnel between each of the nodes
6 Node Type: Admin – ability to create, configure and manage an admin node
7 Node Type: Relay – ability to create, configure and manage a relay node
8 Node Type: Producer – ability to create, configure and manage a producer node
9 Documentation – detailed documentation for milestones 2-8
10 Close-out Report
