GithubHelp home page GithubHelp logo

handbook's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

  • Merge feature/fix-branch into master
  • Merge master into production

Vercel automagically deploys the handbook when a merge is made into production.

handbook's People

Contributors

ayaz1997 avatar bitbeckers avatar burleebau avatar cupojoseph avatar dependabot[bot] avatar fstrauf avatar govinda108108 avatar hhh-gh avatar jonathanprozzi avatar kevinyc-dri avatar kinchasa avatar mackbowes avatar manolingam avatar matthewcarano avatar metafraction avatar oovg avatar plor avatar scottrepreneur avatar smombartz avatar spengrah avatar taenacious avatar uschtwill avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

handbook's Issues

Replace Moloch v2

overview-molochv2-primer doc page is no longer relevant. An updated description of how we use Moloch DAOs would be good to replace this page.

Create Roles Folder and Pages

Our current documentation around Roles: https://handbook.raidguild.org/docs/overview/roles

Problem:

Non-technical roles and their standards are currently not well documented. New members, and members looking to try different roles do not have a source of truth to follow in terms of conduct, expectations, and financial expectations. As things stand to jump into a role you must shadow another member with the same role (learning on the job).

Goals:

It is important to create proper SOPs and documentation around roles (cleric/hunter/scribe/healer/monk especially) to clarify expectations, responsibilities and rewards. Proper knowledge will empower members to switch/pick roles, and reach outside their comfort zones and cover/support when needed.

The most essential information:

  • How does a role fit into a Raid?
  • What is the domain of their responsibilities?
  • What are their limitations?
  • What is their compensation? (Pre-defined or billed separately)
  • Who can new members of that role go to for guidance and advice?
  • Shared resources: (guidelines, blogs, email, channel, support network)

Additional but not required:

  • A table of Raiders with that role? (name, contact)
  • Examples of completed Raids and how that role was played?

update escrow docs

We've modified the escrow to move into dungeon master, this process needs to be updated in the handbook.

Create a Raid Structure Template

Problem:

Our current process for Raids is not well document, but is similar to the following pattern:

Preparation:

  • RG Member/client brings in potential client
  • A conversation is had between Hunter/Cleric, and if there is alignment
  • Create a consultation via the RG site
  • Scope out and budget the work
  • Once a Cleric feels out the availability of a viable team, and the client commits
  • Client deposits fund into a smart escrow or a multisig provided by Raid Team

Kick off:

  • Raid party is assembled, typically with dev(s) and designer(s)
  • If party/project is big enough a Monk will also participate

Raiding:

  • Building is in process
  • Weekly meetings with client

Review:

  • Nearly finished product is delivered to the client
  • A review will commence, typically lasting 10-20% of total allotted time
  • Client is happy, signs off as completed

Wrap up:

  • Client releases funds
  • Raid Party does final hand off
  • Final meeting with client
  • Raid party splits the pay

Goal:

While the general outline of the process is defined, a few of the steps are not well documented and the process is typically on the raiding party. To improve Raid cohesion and address potential pitfalls we need to standardize our process (while leaving freedom to the party)

What we'd like to see is a template which covers the basic standards and processes around a Raid, for example:

  • The Raid Lifecycle: Steps for the Admin raiders to take (Clerics, Hunters, Monks) including consultation queues, client deposits, team formation, reviews, and payments on submission. This documentation will help us clarify what is included within a Raid to both the clients and non-admin raiders, as well as apply standards to admins.
  • Payment Guidelines: Documenting the base standard Raid financial process, for example most Raids have a cleric, and all Raids require a 10% tribute to spoils. This should be made clear to assist in Scoping and Billing, and to introduce clarity for clients. Additionally, Raiders will know when to expect their payments.

Consistency is key, by developing a proper template for Raids we can address many pain points and empower Raiders and Clients to deal with these issues.

Review apprentice process

become-an-apprentice doc could use a review. Since we just completed a cohort it would be good to take this on. One particular thing to note is the hunter route to qualify for membership. This was added informally as a way of incentivizing connections being made to bring work to Raid Guild.

Audit Handbook and Generate Report

Problems:

The handbook has a few issues and areas for improvements that can increase knowledge and access within Raid Guild, below I will a few of the potential issues reported so far:

  • Handbook is outdated
  • Some sections such as championing can be unclear
  • Raider roles are outdated/not well documented, specifically
    • Hunter role
    • Cleric
    • Monk
    • Scribe
  • Dead ends, dead links, confusing wording
  • Lack of documentation for Raid Life-Cycle
  • No/limited info on SOPs, and financial split

Goals:

We will create GitHub issues under this project: https://github.com/orgs/raid-guild/projects/7 to document and manage efforts for improvements, your job will be to:

  • Read the entire handbook, back to back
  • Document any typos, confusing language, unclear info
  • Document any dead-ends, or dead links

Report:

You will generate a report including your findings, as well as any potential improvements that can be made, as long as an issue for it doesn't already exist under this GitHub Project.

Additional but not necessary:

  • It helps if you have experience in many roles, or working with many people across the org.

Discord bots out of date

The discord bots page lists many bots that are no longer installed on the RaidGuild discord server. An updated list of the bots and how to use them should be compiled to replace the existing content.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.