completed

Automate, Educate, Communicate

$9,750.00 Received
$9,750.00 Requested
Ideascale logo View on ideascale
Community Review Results (1 reviewers)
Addresses Challenge
Feasibility
Auditability
解决方案

催化剂学校、QA-DAO和财政部协会的合作将提供激励性的开发、培训材料和开源的交流。

Problem:

没有提供自动化工具的激励措施,没有提供开源培训或沟通Cardano的开源内容。

Yes Votes:
₳ 96,989,567
No Votes:
₳ 11,142,525
Votes Cast:
487

This proposal was approved and funded by the Cardano Community via Project F8: Open Source Development Ecosystem Catalyst funding round.

  • download
  • download
  • download

[IMPACT]

------------------------------------------------------------------------------------

Background

------------------------------------------------------------------------------------

Automation of routine tasks in open source projects enhances their functionality and broadens their utility to a wider audience. But there are barriers to entry in accessing and developing continuous integration tools. These include :

  • A lack of the necessary knowledge or skillset.
  • A lack of understanding of what GitHub Actions can offer in open source projects.
  • A GitHub marketplace aimed at general solutions or platforms.
  • A lack of examples of GitHub Actions being used in Project Catalyst

------------------------------------------------------------------------------------

Proposed Solution - Automate, Educate, Communicate

------------------------------------------------------------------------------------

Automate

------------------------------------------------------------------------------------

The first part of this proposal addresses

  • What to automate &
  • How to incentivize development, documentation & transfer of knowledge

What to automate : we intend to focus on Actions that will automate Treasury Guild & governance projects such as Catalyst Circle Admin. This will provide a discrete context on which to build a library of Actions.

How to incentivize : Development, documentation & transfer of knowledge will be incentivized by offering an hourly fee and a structured submission process (see example here).

Each GitHub Action submitted must include :

  • An Overview : providing context, a description of its function and documentation with screenshots.
  • A Reference Example : providing a link to example of the GitHub Action working in production.
  • The Code : A complete listing of the YAML script
  • A brief Budget : Specifying hours worked on development, testing, documentation & implementation in production.

Each submission will be reviewed & signed-off (if successful) by Andre Diamond and/or Stephen Whitenstall

-----------------------------------------------------------------------------------

Educate

------------------------------------------------------------------------------------

The second part of this proposal addresses

  • Production of open source training materials

This part of the proposal builds upon materials currently being prepared as part of the Fund 6 : Open Source Training project. Elements of workshops & presentations such as 'How to build a Challenge Team GitBook' and 'Circle Admin GitHub Training' will be broken down into more digestible parts.

This will include :

  • Slides - to be used in future Catalyst School sessions & presentations.
  • Timestamps - more descriptive timestamps of workshop recordings to guide learning.
  • Transcripts & summaries - textual content produced for 'How to' guides.
  • Feedback - useful comments & suggestions from past participants.

-----------------------------------------------------------------------------------

Communicate

-----------------------------------------------------------------------------------

The third & final part of this proposal addresses

  • How to communicate what open source means to Cardano & Catalyst

This part of the proposal will draw on research into the Cardano open source roadmap and authoritative definitions of open source such as the Open Source Initiative. We intend to investigate what a committment to open source actually means for community partipation and communicate this through presentations & workshops.

This will include :

  • Research into the Cardano open source roadmap, open source definitions & associated community projects
  • Presentations & workshops on opensource themes

----------------------------------------------------------------------------------------

This proposal addresses the challenge by providing :

  • Education in the form of open source training in GitHub and associated tools such as GitBook
  • Incentives to develop GitHub Actions, document them and host them in open repositories as common tools
  • Training events in collaboration with Catalyst School, QADAO & the Treasury Guild
  • A grassroots, bottom-up approach to open source knowledge transfer
  • All development & training materials will be freely available under an open source license
  • A commitment to abide by The Open Source Definition - https://opensource.org/osd

––––––––––––––––––––––––––––––––––––––––––––

Proliferation of information sources

There is an emerging risk of proliferation of information sources in the Catalyst community. To mitigate this QADAO is following a strategy of aggregating sources. For example merging GitBooks where possible, migrating content to open source websites or listing content on aggregation sites.

[FEASIBILITY]

----------------------------------------------------------------------------------------

Timeline

February 2022 to April 2022

  • QADAO in partnership with Treasury Guild setup our merged projects - <https://quality-assurance-dao.gitbook.io/training-and-automation/>
  • Automate - First prototype GitHub Actions documented - <https://quality-assurance-dao.gitbook.io/training-and-automation/circle-automation/town-hall-slides> - supporting Catalyst Circle Admin procedures.
  • Educate - Open Source Training materials aggregated & documented - <https://quality-assurance-dao.gitbook.io/training-and-automation/open-source-training/overview>
  • Communicate - Setup pipeline to Catalyst School Website
  • Course materials will be embedded in the Catalyst School Website.
  • New GitHub Actions and Open Source Training are marketed on social media.

---------------------------------------------------------------------------------------

May 2022

  • Funding decision and on-boarding

June 2022

  • Automate - GitHub Actions incentivized, developed & documented.
  • Educate - First presentation or workshop
  • Communicate - Course materials will be embedded in the Catalyst School Website. Social Media marketing.

July 2022

  • Automate - GitHub Actions incentivized, developed & documented.
  • Educate - Second presentation or workshop
  • Communicate - Course materials will be embedded in the Catalyst School Website. Social Media marketing.

August 2022

  • Automate - GitHub Actions incentivized, developed & documented.
  • Educate - Third presentation or workshop
  • Communicate - Course materials will be embedded in the Catalyst School Website. Social Media marketing.

-----------------------------------------------------------------------------------

Budget

-----------------------------------------------------------------------------------

(Automate) GitHub Action Incentives :

  • To incentivise GitHub Actions with An Overview, A Reference Example, A brief Budget : $ 400 per Action (depending on hours worked at $55 per hour). Review & Sign Off : $55 (estimated at an hours work). = $455 per Action.
  • 6 GitHub Actions in 3 months : 6 X $455 = 2,730

Sub Total: 2,730

(Educate) Production of Training Materials

Conversion & editing of presentations, workshops & slides

Each presentation or workshop :

  • Conversion & editing = 8 hours at $55 per hour = $ 440. 3 X presentations or workshops during the course of the project = $ 1,320

Sub Total: $ 1,320

(Communicate) Presentations & workshops

Each presentation & workshop:

  • Preparation & research = 24 hours = $55/hour for 24 hours = $ 1,320
  • Presentation, hosting, facilitation & recording = 4 hours at $55 per hour = $ 220. 3 X presentations & workshops during the course of the project = $ 660

Sub Total: $ 1,980

(Communicate) Social Media Engagement

  • Promotion, engagement and communication on social media: Twitter, Telegram, Youtube, Discord & Reddit
  • 2 hours/week for 3 months = 24 hours = $55/hour for 24 hours

Sub Total: $ 1,320

(Treasury) Administration of Budget

  • Proposal Wallet setup, admin and payments
  • 5 hours/week for 3 months = 60 hours = $40/hour for 60 hours

Sub Total: $2400

Total : $ 9750

––––––––––––––––––––––––––––––––––––––––––––

Stephen Whitenstall has 30 years' experience in organizing academic, community and business projects. Relevant experience for this proposal includes Program Test Management (IBM) and Quality Assurance Management (BNP-Paribas). He is the co-founder of QADAO (https://quality-assurance-dao.github.io/) which aims to provide Quality Assurance services to Cardano.

He currently develops, maintains documentation and provides technical project management support for Catalyst Swarm, Catalyst School, Catalyst Circle, Community Governance Oversight, Audit Circle & Eastern Town Hall.

Treasury Guild offers a 1 to 1 accounting and treasury service to projects within the Catalyst Ecosystem. Setting up and managing Project Wallets and the distribution of funds. Keeping track of all budget items and the exchange rate at which the funds were released to ensure that the budget is spent correctly. Including metadata in the transactions enabling future dapps to pull data and create dynamic tailor made dashboards & templates.

Andre Diamond has experience in small business operation and accounting. Joined the Catalyst Circle Admin team as treasurer in Nov 2021 and has expanded this role by starting the Treasury Guild alongside Miroslav to support projects in the Catalyst community as well. Currently using and documenting GitHub actions to help automate some of the tasks in Catalyst Circle and treasury work.

Miroslav Rajh has 20 years of experience in managing finances and organizing the business of NGOs and the University. He also worked as a Human Resources Manager (HRM). Joined the Catalyst Circle Admin team together with Andre as treasurer in Nov 2021. Currently he is recording, documenting and managing all transactions for CC Admin Team, Swarm, Cardano4Climate, Community Governance and Bridge Builders.

Catalyst School - Catalyst School is a place to leverage the impact of Catalyst as a whole by introducing and improving the contribution of all its different players and roles. For more details check out the Catalyst School Website : <https://beta.thecatalyst.school/>

[AUDITABILITY]

––––––––––––––––––––––––––––––––––––––––––––

QADAO will continue to measure the progress and development of this project in a similar manner to the preceding Fund 6 proposals Distributed Auditability & Open Source Training in a dedicated Training & Automation GitBook.

In brief this document will provide an overview with a project timeline, budget expenditure details & a copy of the monthly report to IOG.

Progress will be measured and tracked against the success criteria given below.

--------------------------------------------------------------------------------------

Success criteria

Success criteria will include evidence of the following deliverables :

Quantitative

  • (Automate) GitHub Actions - Number of Actions developed & documented over 3 months.
  • (Educate) Production of Training Materials - 3 X workshops or presentations over 3 months
  • (Educate) Transfer & Migration of Training Materials to Catalyst School - Adaptation & migration of training materials from 3 X workshops or presentations over 3 months
  • (Communicate) Social Media Engagement - Promotion, engagement and communication on social media: Twitter, Telegram, Youtube, Discord & Reddit
  • (Communicate) Presentations & workshops - 3 X workshops or presentations over 3 months

Qualitative

  • Increased engagement in open source issues.
  • Increased engagement in open source road map in Catalyst.

--------------------------------------------------------------------------------------

This proposal merges two previous proposals. The funds for these proposals will support development of GitHub Actions & Open Source Training until May 2022

  • F6 Distributed Auditability - <https://cardano.ideascale.com/c/idea/366707>
  • F6 Open Source Training - <https://cardano.ideascale.com/c/idea/368678>

社区顾问评论 (1)

Comments

Monthly Reports

This is a link to our Gitbook where we document everything - https://quality-assurance-dao.gitbook.io/training-and-automation/introduction-and-pat-tokens/introduction-to-github-actions - And here is a link to our GitHub repo project board - https://github.com/orgs/Catalyst-Auditing/projects/5/views/1 - We created a project board and discussed and added action items.

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
9/1/2022
Comments 0

Login or Register to leave a comment!

We have mostly just been closing off the old proposals and getting everything ready for this new proposal. Once we have closed the old ones we will start creating the environment for this proposal. This includes setting up dework and a list of bounties that people from the community can take. We have been meeting mostly twice a week to work on this. Another thing we've been working on passively is using the project board and trying to identify ways of automating some of the actions we do every week. The idea is to find a way to use the project board a certain way and then automate a bunch of things and possibly create content that can assist in the monthly and close out report.

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
9/1/2022
Attachment(s)
Comments 0

Login or Register to leave a comment!

We finished our old proposals and started planning on the work for this proposal. We will begin work early next month. Please continue to halt the release of funds for this project. We will ask for funding again when work has been done. Here is a link to our project board in GitHub - https://github.com/orgs/Catalyst-Auditing/projects/5/views/1

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
2. In the next 3 months
Attachment(s)
Comments 0

Login or Register to leave a comment!

We are dropping bounty system for the following reasons.

We struggled to add items to the bounty wish list. We saw that funded projects need help with treasury and project management In order to design automations we would need to research what is needed in these projects as they are all different from each other. Research can be done by helping funded projects and identifying new automations in the process. Decided to shift our focus to doing this research and create automations where needed. We found that our own resources were sufficient to develop GitHub actions and there was insufficient bounty applications

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

We continued testing the new automated Agenda on our project board and so far there hasn't been any errors or bugs. We had to transfer and update our Gitbook with all the changes we made to the project to prepare for work we will do on possible Fund 9 proposals. We created an automation that automatically labels a newly created Issue on the project board with ADA Due. So essentially we will only add items on the project board if they are payable tasks. We started documentation in our Gitbook on these newly created automations.

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

We are involved and doing research in another project (Governance Services Guild) where we are trying to identify automations that can be done on the project board that also integrates with dework. We have seen opportunities for automations, but more iterations is needed to refine the weekly processes. Once patterns are identified and verified to be consistent, we can dedicate to automating those processes. Whatever we find in this research will be brought over to this project to document and use as inspiration for more possible automations. We also closed a few tasks on the project board this month, mostly admin work, making room for more automation work.

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

We are gathering information from the other projects we are involved in. Every project has a different way of doing project management and reporting. We will use the information we gather to identify new automations. GitHub is also receiving new updates which will enable new kinds of automations. We will look at these new updates as they roll out. Once we identified any possible automations we will put them on the project board.

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
3. In the next 6 months
Comments 0

Login or Register to leave a comment!

We are involved in a few projects and all of them have different approaches when it comes to project management. We are continuesly looking at these different approaches and trying to identify possible automations. We noticed a lot of groups using dework and trying to identify a way to integrate GitHub with Dework and the processes involved to make the automations on GitHub's side effective. Dework has some issues feeding information to GitHub so we need to create a process that feeds from GitHub to Dework.

Disbursed to Date
$9,750
Status
Still in progress
Completion Target
3. In the next 6 months
Comments 0

Login or Register to leave a comment!

close

Playlist

  • EP2: epoch_length

    Authored by: Darlington Kofa

    3分钟24秒
    Darlington Kofa
  • EP1: 'd' parameter

    Authored by: Darlington Kofa

    4分钟3秒
    Darlington Kofa
  • EP3: key_deposit

    Authored by: Darlington Kofa

    3分钟48秒
    Darlington Kofa
  • EP4: epoch_no

    Authored by: Darlington Kofa

    2分钟16秒
    Darlington Kofa
  • EP5: max_block_size

    Authored by: Darlington Kofa

    3分钟14秒
    Darlington Kofa
  • EP6: pool_deposit

    Authored by: Darlington Kofa

    3分钟19秒
    Darlington Kofa
  • EP7: max_tx_size

    Authored by: Darlington Kofa

    4分钟59秒
    Darlington Kofa
0:00
/
~0:00