Browse Source

Updated about pages and guides for v3 refactor

Nathan Schneider 2 years ago
parent
commit
9a6918ba8d
5 changed files with 13 additions and 14 deletions
  1. 2 4
      README.md
  2. 1 1
      _about/faq.md
  3. 4 4
      _guides/first_rule.md
  4. 4 3
      _guides/git_repo.md
  5. 2 2
      about.md

+ 2 - 4
README.md

@@ -8,8 +8,6 @@ A governance toolkit for great communities, located at [communityrule.info](http
 
 
 This project welcomes contributors. All contributions are assumed to accept the project's GPL and Creative Commons licenses.
 This project welcomes contributors. All contributions are assumed to accept the project's GPL and Creative Commons licenses.
 
 
-To contribute governance templates, copy create.md at _create/[template_name].md and fill out the YAML metadata. This will automatically add a new template into the system.
+To contribute governance templates, copy an existing one at _template/[template_name].md and fill out the YAML metadata. This will automatically add a new template into the system. Propose edits to existing governance templates at _template/[template_name].md.
 
 
-Propose edits to existing governance templates at _create/[template_name].md.
-
-Most of CommunityRule's interactive features occur at _layouts/rule.html and _includes/rule-scripts.js. The Module data is located in _modules/.
+To get involved, [contact MEDLab](mailto:medlab@colorado.edu).

+ 1 - 1
_about/faq.md

@@ -40,7 +40,7 @@ A bunch of stuff, and we have a running list in the [Issues on GitLab](https://g
 
 
 **What projects does this draw upon?**
 **What projects does this draw upon?**
 
 
-* Created with [Jekyll](https://jekyllrb.com/) (MIT License), hosted on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)
+* Created with [Jekyll](https://jekyllrb.com/) (MIT License) and [Vue.js](https://vuejs.org/) (MIT License), hosted on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)
 * Icons are from [Tabler](https://github.com/tabler/tabler-icons) (MIT License)
 * Icons are from [Tabler](https://github.com/tabler/tabler-icons) (MIT License)
 * Database runs on [Stein](https://steinhq.com/) (MIT License), using [this Google Doc](https://docs.google.com/spreadsheets/d/12IgsMWZNzPv2nS7ksU6CUozcS6YYwRn9O1iIXKat3V4/edit?usp=sharing)
 * Database runs on [Stein](https://steinhq.com/) (MIT License), using [this Google Doc](https://docs.google.com/spreadsheets/d/12IgsMWZNzPv2nS7ksU6CUozcS6YYwRn9O1iIXKat3V4/edit?usp=sharing)
 * Modules work on mobile thanks to [dragdroptouch](https://github.com/Bernardo-Castilho/dragdroptouch) by Bernardo Castilho (MIT License)
 * Modules work on mobile thanks to [dragdroptouch](https://github.com/Bernardo-Castilho/dragdroptouch) by Bernardo Castilho (MIT License)

+ 4 - 4
_guides/first_rule.md

@@ -8,15 +8,15 @@ Whether your community is already up and running or still just an ambition, choo
 
 
 **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.
 **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.
 
 
-**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">Fork</span> button at the bottom 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.
+**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 "Fork & Edit" button at the bottom 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.
 
 
-**Drag and drop modules to design your Rule.** Under the community name and basic structure, you can start dragging pre-defined or custom modules into your Rule. You can drag a module into another module to show how the parent module works in greater detail.
+**Add modules to design your Rule.** Under the community name and basic structure, you can start adding custom or pre-defined modules into your Rule. Click the option you want, and press the "+ Add" button to add it to the Rule field above. You can drag a module into another module to show how the parent module works in greater detail.
 
 
-**If you use the modules, be sure to explain what they mean.** When you add a module or click on its name, a field appears that allows you to describe the module in your own words. Text typed there automatically becomes part of the module, and it will appear when you hover the cursor over its name. For inspiration, you can press the ![More info]({% link assets/tabler_icons/info-circle.svg %}) icon on pre-defined modules to learn more about them.
+**If you use the modules, be sure to explain what they mean.** When you add a module or click on its name, a field appears that allows you to describe the module in your own words. Text typed there automatically becomes part of the module, and it will appear when you hover the cursor over its name.
 
 
 **Separate the Rule from its data**. Think of your Rule like a constitution as opposed to a code of laws, like a building as opposed to the people who put it to use. Don't try to include all your community's policies in your Rule; explain there how you make and change policies. Don't list out who holds what roles; just define the roles. In your Rule, make clear where people can find that data---the policies, the role-holders, and so forth.
 **Separate the Rule from its data**. Think of your Rule like a constitution as opposed to a code of laws, like a building as opposed to the people who put it to use. Don't try to include all your community's policies in your Rule; explain there how you make and change policies. Don't list out who holds what roles; just define the roles. In your Rule, make clear where people can find that data---the policies, the role-holders, and so forth.
 
 
-**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. The <span class="pushButton">Preview</span> button provides a clean display for easy reading. Just press <span class="pushButton">Customize</span> when you're ready to edit again. Show it to your community for feedback.
+**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. The "Preview" button provides a clean display for easy reading. Just press "Customize" when you're ready to edit again. Show it to your community for feedback.
 
 
 **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 export it as a Markdown file (which you can add to your own website or [Git repository]({% link _guides/git_repo.md %}).
 **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 export it as a Markdown file (which you can add to your own website or [Git repository]({% link _guides/git_repo.md %}).
 
 

+ 4 - 3
_guides/git_repo.md

@@ -4,15 +4,16 @@ title: "Add a Rule to a software project's Git repository"
 permalink: /guides/git-repo/
 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?
+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. Likewise, a `GOVERNANCE` file can define how the project is governed.
 
 
 **CommunityRule makes it easy to include governance information in a software repository.** There are two ways to do it:
 **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.
 **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">Export</span> button
+* At the bottom of the page where you have authored your Rule, press the "Download" 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
 * 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)
+* Find the file on your computer and rename it to `GOVERNANCE.md`
+* For easier reading, remove the YAML metadata at the bottom; delete everything beginning with `\`\`\``
 * Place the file in the main directory of your project, either by uploading to GitHub/Lab or adding it to Git locally:
 * Place the file in the main directory of your project, either by uploading to GitHub/Lab or adding it to Git locally:
 
 
 <pre>
 <pre>

+ 2 - 2
about.md

@@ -4,7 +4,7 @@ title: About
 permalink: /about/
 permalink: /about/
 ---
 ---
 
 
-## CommunityRule is a governance toolkit for great communities!
+## CommunityRule is a governance toolkit for great communities
 
 
 > *"For everyone to have the opportunity to be involved in a given group and to participate in its activities the structure must be explicit, not implicit. The rules of decision-making must be open and available to everyone, and this can happen only if they are formalized."* (Jo Freeman, "The Tyranny of Structurelessness")
 > *"For everyone to have the opportunity to be involved in a given group and to participate in its activities the structure must be explicit, not implicit. The rules of decision-making must be open and available to everyone, and this can happen only if they are formalized."* (Jo Freeman, "The Tyranny of Structurelessness")
 
 
@@ -16,6 +16,6 @@ The governance practices we share here have long roots in diverse cultures. To e
 
 
 CommunityRule is a project of the [Media Enterprise Design Lab](https://www.colorado.edu/lab/medlab/) at the University of Colorado Boulder, in collaboration with the [Metagovernance Project](https://metagov.org).
 CommunityRule is a project of the [Media Enterprise Design Lab](https://www.colorado.edu/lab/medlab/) at the University of Colorado Boulder, in collaboration with the [Metagovernance Project](https://metagov.org).
 
 
-CommunityRule is currently administered and primarily authored by MEDLab director Nathan Schneider. If a community of contributors and users forms around CommunityRule, it should develop into a more community-driven governance model with the help of CommunityRule itself.
+CommunityRule is primarily authored by MEDLab director Nathan Schneider and [Drew Hornbein](https://dhornbein.com/), who also administer the project. If a community of contributors and users forms around CommunityRule, it should develop into a more community-driven governance model with the help of CommunityRule itself.
 
 
 To contribute to the project, post Issues and Merge Requests to the [project on GitLab](https://gitlab.com/medlabboulder/communityrule), or send an email to medlab@colorado.edu.
 To contribute to the project, post Issues and Merge Requests to the [project on GitLab](https://gitlab.com/medlabboulder/communityrule), or send an email to medlab@colorado.edu.