Browse Source

Created Guides section with first 3 entries

Nathan Schneider 4 years ago
parent
commit
55d78171b6
4 changed files with 92 additions and 0 deletions
  1. 27 0
      _guides/first_rule.md
  2. 35 0
      _guides/git_repo.md
  3. 17 0
      _guides/publish_rule.md
  4. 13 0
      guides.md

+ 27 - 0
_guides/first_rule.md

@@ -0,0 +1,27 @@
+---
+layout: page
+title: "[Guide] Create your first rule"
+permalink: /guides/first-rule/
+---
+
+Whether your community is already up and running or still just an ambition, choosing and adopting an initial Rule can be a challenge. Some community members might resist the idea, preferring a more informal way of operating. But for almost any kind of community, there are benefits to having governance plans in place---even if most of the time they're just sitting in the background. Like a sewage system, a governance system may be working best when it goes unnoticed.
+
+**Describe the reality, not the ideal.** Start with where you are. If your community values democracy but currently runs as an autocracy, own up to it in your Rule. You might also include in your Rule the intention of changing in the future. But sometimes the best way to spur change is to hold a mirror up to how the community is presently operating. Start by describing briefly and clearly how your community operates now.
+
+**Get that? Be brief.** The longer your Rule is, the more likely you'll be to confuse people and introduce internal inconsistencies.
+
+**It may be easiest to start with a [template]({% link templates.md %}), but you can also [start from scratch]({% link create.md %}).** On a template, press the <span class="pushButton">Customize</span> button to get started. Even if you end up changing almost everything you find in a template, the process can spur thinking in ways that a blank canvas would not.
+
+**Press the <span class="pushButton">+</span> buttons to expand each section and start exploring.** You don't need to fill every field or even every section. If you don't leave an answer, the field will simply disappear when you publish.
+
+**Answer the questions in complete sentences**, because the questions will disappear when you publish. Make sure what you write will make sense when the questions are no longer there.
+
+**Use the Modules for inspiration.** These suggestions are drawn from [Democratic Mediums](https://democraticmediums.info), a sister project that aims to collect governance patterns from diverse contexts.
+
+**Read and re-read.** Be sure that all the terminology and processes are consistent. Inevitably there will be loopholes and bugs, but try to resolve as many of them as you can.
+
+**When you've finished a draft, show it to your community for feedback.** Others will probably think of things that didn't occur to you. This may even raise some important issues about how different members were perceiving the community differently. Aim to reach unanimity---or something close to it---about your first Rule.
+
+**When you're ready to adopt your Rule, put it in a place where your community can easily find it.** Depending on the spaces and tools your community uses, this can mean different things. But one way or another, make your Rule accessible. CommunityRule offers two options: [Publish your Rule to the Library]({% link _guides/publish_rule.md %}) (and provide your community with a link), or download it as a Markdown file (which you can add to your own website or [Git repository]({% link _guides/git_repo.md %}).
+
+**Prepare for your Rule to evolve.** Make sure you and your Rule are prepared for change. Often, soon after a Rule is up and running, simple problems arise that would have been hard to notice or predict on paper. Celebrate once you've adopted your first Rule, but let it be a living document.

+ 35 - 0
_guides/git_repo.md

@@ -0,0 +1,35 @@
+---
+layout: page
+title: "[Guide] Add a Rule to a software project's Git repository"
+permalink: /guides/git-repo/
+---
+
+Free/open-source software projects typically have a series of files that contain basic information about how the project works. Platforms like GitHub and GitLab encourage this. For instance, `README` serves as a kind of landing page for users and potential contributors; `LICENSE` specifies the legal terms under which the software is made available; `CONTRIBUTING` explains how contributors should submit changes to the project. But what about governance? Where does it say who is in charge of approving changes and choosing the direction of the project?
+
+**CommunityRule makes it easy to include governance information in a software repository.** There are two ways to do it:
+
+**Method 1: Export a Markdown file of your Rule and add it.** Once you've created your Rule on CommunityRule, you can download it and then put it in your respository.
+
+* At the bottom of the page where you have authored your Rule, press the <span class="pushButton">Markdown</span> button
+* Depending on your browser's settings, pressing the button should download the file and either open it or ask you where you would like to save it
+* Find the file on your computer and rename it to `GOVERNANCE.md` (replacing the current .txt extension)
+* Place the file in the main directory of your project, either by uploading to GitHub/Lab or adding it to Git locally:
+
+<pre>
+mv [file_location]/GOVERNANCE.md [project_location]/
+cd [project_location]
+git add GOVERNANCE.md
+git commit -am "Added GOVERNANCE.md, derived from CommunityRule"
+</pre>
+
+
+**Method 2: Publish your Rule on CommunityRule and link to it.** This way, you're not hosting the Rule directly in your repository but allowing CommunityRule to host it for you.
+
+* Follow the [Guide on how to publish a Rule]({% link _guides/publish_rule.md %})
+* In the README.md file for your project, add a line like the following:
+
+<pre>
+[Read our Rule]([URL of published Rule]) to learn how this project is governed. [![CommunityRule derived](https://communityrule.info/assets/CommunityRule-derived-000000.svg)](https://communityrule.info)
+</pre>
+
+Whichever approach you take, **make sure that your Rule is accessible to any participant in your project.**

+ 17 - 0
_guides/publish_rule.md

@@ -0,0 +1,17 @@
+---
+layout: page
+title: "[Guide] Publish a Rule on CommunityRule"
+permalink: /guides/publish-rule/
+---
+
+**CommunityRule is not just a tool for creating governance documents, it's a platform for publishing and sharing them.** Rules that have already been published are available at the [Library]({% link library.md %}). You can publish both works in progress and actively adopted Rules. You can also keep earlier drafts of a Rule in the Library; each published Rule has a unique URL and timestamp.
+
+Note that, currently, the Library tool is quite crude and published Rules cannot be edited once published.
+
+**Once you've written, edited, and re-edited your Rule, press <span class="pushButton">Publish</span>.** This will generate a unique URL for your Rule and display it. You can now link to this URL and use it as the official version for your community. The Rule is now also publicly available in the Library.
+
+**Your Rule is automatically licensed for re-use.** As a condition of using CommunityRule, published Rules are made available under a Creative Commons BY-SA license. That means others are free to adapt your Rule and should credit the source.
+
+**You or others can fork your Rule to build on it.** "Forking" means taking an existing product, copying it, and revising it into something new. You can use this feature to create a revision of your Rule, and others can use it to generate their own Rule based on yours.
+
+**You can also delete your Rule.** Currently, if you press the <span class="pushButton"><img src="{% link assets/tabler_icons/trash.svg %}" /></span> button, it should open an email to CommunityRule's developers for a deletion request. We will work on streamlining this process so that it will be more straightforward for Rule creators to delete their own Rule.

+ 13 - 0
guides.md

@@ -0,0 +1,13 @@
+---
+layout: page
+title: Guides
+permalink: /guides/
+---
+
+These guides walk you through ways of using CommunityRule.
+
+* [Create your first rule]({% link _guides/first_rule.md %})
+* [Publish a Rule on CommunityRule]({% link _guides/publish_rule.md %})
+* [Add a Rule to a software project's Git repository]({% link _guides/git_repo.md %})
+
+Want a guide on another topic? Let us know!