agaric/documentation
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Compare commits

base: agaric:main
Branches Tags
agaric:main
agaric:wolcen-main-patch-08376
..
compare: agaric:wolcen-main-patch-08376
Branches Tags
agaric:main
agaric:wolcen-main-patch-08376

No commits in common. "main" and "wolcen-main-patch-08376" have entirely different histories.
main ... wolcen-mai

44 changed files with 456 additions and 1104 deletions
Show stats Expand all files Collapse all files

5
.readthedocs.yml
View file

@ -1,8 +1,9 @@
version: 2
build:
os: ubuntu-22.04
os: ubuntu-20.04
tools:
python: "3.10"
python: "3.9"
sphinx:
configuration: conf.py
python:

6
README.md
View file

@ -1,6 +0,0 @@
Test changes to this documentation locally:
```bash
pip install -r requirements.txt
sphinx-build -b html . _build/html
```

2
agaric-website/agaric-site-content-entry.md
View file

@ -2,7 +2,7 @@
*Or, a guide to Agaric's experimental branch of Drutopia.*
First, familiarize yourself with Agaric's tone and voice as described in [Agaric's content style guide](/content-style-guide.md).
First, familiarize yourself with Agaric's tone and voice as described in [Agaric's content style guide](content-style-guide).
Second, add content! Most commonly, this will be blog posts.

4
agaric-website/basics.md
View file

@ -12,7 +12,3 @@ Agaric's main web site is built on [Drutopia](https://drutopia.org/) and most of
* The main image, like the summary, is used only for teasers (blog listings, search results). It is therefore requested that you incorporate this image into the early content of your
* Do *not* use a title paragraph for blogs, in general, as we don't currently have a way of showing the author and date posted information.
```{seealso}
[Agaric's Content Style Guide](/content-style-guide.md)
```

0
tools/big-blue-button.md → big-blue-button.md
View file

23
calendars.md
View file

@ -22,26 +22,11 @@
![Dropdown list starting with 'Show All Calendars' with 'New Calendar...' selected.](images/add-new-calendar.png)
2. Choose the **On the Network** option and press the **Next** button
![A dialog to 'Create a new calendar' with two radio button options and the second, 'On the Network' selected.](images/new-calendar-on-network.png)
3. Enter your username and the calendar link copied in step 0. Leave 'This location doesn't require credentials' unchecked. The 'Offline Support' option enables calendar use when offline.
![A dialog to 'Create a new calendar' with a username text field option, a location text field expecting a calendar(s) url, and two checkboxes 'This location doesn't require credentials' and 'Offline Support' with 'Offline Support' selected.](images/mayfirst-specific-calendar.png)
4. Choose the **CalDAV** option, select the calendar requested from the url in the previous step and press the 'Subscribe button'
![A dialog to 'Create New calendar' showing a Calendar Type dropdown with, the second option, 'CalDAV', selected, and a checkbox option with the requested calendar](images/choose-caldav-and-calendar.png)
5. Give your calendar a name, sticking to the name used in NextCloud to the extent practical, and save the dialog, and you're done!
6. Ensure your calendar is associated with the e-mail address with which you want to receive invites.
### Subscribe to all Calendars at Once
You can subscribe to all calendars that have been shared with you by using the https://share.mayfirst.org rather than a specific calendar's url.
0. Repeat instructions 1 and 2 from the 'Subscribe to a NextCloud calendar' section.
1. Add your username in the username field and 'https://share.mayfirst.org' in the location field.
![A dialog to 'Create a new calendar' with a username text field option, a location text field expecting a calendar(s) url, and two checkboxes 'This location doesn't require credentials' and 'Offline Support' with 'Offline Support' selected.](images/import-all-calendars.png)
2. Your calendar and all calendars shared with you are listed in the checkboxes. Choose the calendars you would like to import into your Thunderbird calendar.
![A dialog to 'Create New calendar' with checkboxes listing your calendar and all calendars shared with you.](images/choose-calendars-to-import.png)
3. Choose the **CalDAV** option, paste the private link from the first step in the **Location** text field (leave the username blank) and press the **Next** button
![A dialog to 'Create a new calendar' showing four radio buttons, the second one, 'CalDAV', is selected, and a URL is present in a text field labeled 'Location'.](images/thunderbird-add-nextcloud-calendar.png)
4. Give your calendar a name, sticking to the name used in NextCloud to the extent practical, and save the dialog, and you're done!
5. Ensure your calendar is associated with the e-mail address with which you want to receive invites.
```{note}
Members of Agaric can share their private calendar links to the [internal Agaric wiki](https://gitlab.com/agaric/internal/-/wikis/calendars ).
```
```{note}
More documentation here: https://support.mozilla.org/en-US/kb/creating-new-calendars
```

19
client-communication/document-versioning-filenames.md
View file

@ -1,19 +0,0 @@
# Document versioning and filenames
Please use the following file naming convention for all client-facing filenames:
```
agaric-[client-name]-[purpose]-[yyyy-mm-dd].ext
```
For example:
```
agaric-acme-jetpacks-proposal-2024-05-23.pdf
```
Always use dates, do not use revision numbers, and never use 'final' in a file name. A final-final-FINAL doc is only funny a couple times.
This applies to the final sent versions of files, typically PDFs. The word processing document (.odt, .doc) or Markdown (.md) working versions should follow the same format for their file names, for convenience, but leave off the date.
For more on document naming reasoning see [Orr Shtuhl in *A List Apart* on avoiding trouble by making deliverables easy to find](https://alistapart.com/article/looking-for-trouble/#section2).

15
conf.py
View file

@ -19,10 +19,9 @@
# -- Project information -----------------------------------------------------
project = u'Agaric Technology Collective'
copyright = u'2006—2024, Agaric, LLC'
author = u'Benjamin Melançon, Michele Metts, Christopher Thompson, Mauricio Dinarte, David Valdez, Clayton Dewey'
html_baseurl = 'https://docs.agaric.coop/'
project = u'Agaric Collective'
copyright = u'2006—2021, Agaric, LLC'
author = u'Benjamin Melançon, Michele Metts, Mauricio Dinarte, David Valdez, Clayton Dewey'
# The short X.Y version
version = u''
@ -47,9 +46,6 @@ extensions = [
'sphinx_rtd_theme',
]
myst_heading_anchors = 5
suppress_warnings = ["myst.xref_ambiguous"]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -76,7 +72,7 @@ release = u''
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@ -105,6 +101,7 @@ html_css_files = [
# TIP: If it starts with `html_` it belongs directly as a conf.py option and
# NOT in html_theme_options.
html_theme_options = {
'canonical_url': 'https://docs.agaric.coop/',
'logo_only': True,
}
@ -128,7 +125,7 @@ html_context = {
"display_gitlab": True, # Integrate Gitlab
"gitlab_user": "agaric", # Organization
"gitlab_repo": "documentation", # Repo name
"gitlab_version": "main", # Version
"gitlab_version": "master", # Version
"conf_py_path": "/", # Path in the checkout to the docs root
}

227
content-style-guide.md
View file

@ -8,22 +8,32 @@ Good content is authentic, useful, and appropriate to its context.
Agaric's voice is straightforward, bold, and irreverant.
[Write for translation](#writing-for-translation) by writing clear, straightforward English. [Write for accessibility](#writing-for-accessibility) by doing the same and by organizing information, steering clear of distractions, and being mindful of alternative ways of processing information (including non-visual).
* Group related ideas together with descriptive headers and subheaders.
* Lead with the main point.
### Writing about people
We write and build apps with a person-first perspective. Being aware of the impact of language is one way for us to live out our [values](values).
* Do not reference age or ability unless it is immediately relevant.
* Avoid gendered language and use the singular they.
* When writing about a person, use their preferred pronouns; if you do not know those, use their name.
* Related resource: [The Conscious Style Guide](https://consciousstyleguide.com/).
### Grammar and mechanics
Some people will read every word you write. Others will just scan. Help everyone by grouping related ideas together and using descriptive headers and subheaders.
Focus your message, and create a hierarchy of information. Lead with the main point or the most important content.
* Use active voice and positive language.
* Use short words and sentences.
* Avoid unnecessary modifiers.
* Use specific examples; avoid vague language.
* Be consistent. (This guide is here to help!).
* Use specific examples.
* Avoid vague language.
* Be consistent. Adhere to the copy patterns and style points outlined in this guide.
* Do not use contractions as they cheapen the content and provide difficulty for readers of other languages.
* Use the serial comma. (Also known as the Oxford comma, it helps clarify when items in a list of three, four, or more things are their own items.)
* Do not use underline or all-uppercase capitalization for emphasis.
* Avoid combining *italics* and **bold** (***except as last-resort extra emphasis***).
* Skip unnecessary images and when including pictures or graphics provide alt text (image descriptions).
* Lower barriers to taking action by ensuring links are descriptive and that in forms all fields have labels that are present and clear with a minimum of required fields.
* Leave out irrelevent characterizations, especially when [writing about people](#writing-about-people).
* Use the serial comma. Otherwise, use common sense. (Also known as the Oxford comma, it helps clarify when items in a list of three, four, or more things are their own items.)
* Do not use underline for emphasis, and do not use any combination of italic, bold, caps, and underline.
* When in doubt, read your writing out loud.
Many of these repeat or reinforce George Orwell's six rules from his essay "Politics and the English Language" (1946), and it is worth keeping all of them in mind, especially the last:
@ -35,9 +45,30 @@ Many of these repeat or reinforce George Orwell's six rules from his essay "Poli
> (v) Never use a foreign phrase, a scientific word, or a jargon word if you can think of an everyday English equivalent.
> (vi) Break any of these rules sooner than say anything barbarous.
[Much more on grammar and mechanics](#grammar-and-mechanics).
## Goals and Principles when writing
### Writing for accessibility
* Create a hierarchy, with the most important information first.
Place similar topics in the same paragraph, and clearly separate different topics with headings.
* Use plain language. Write short sentences and familiar words.
* Links should provide information on the associated action or destination. Avoid saying “click here” or “learn more.”
* Avoid using images when descriptive text will do.
* Avoid directional instructions or language that requires the reader to see the layout or design of the page.
* Label inputs on forms with clear names and use appropriate tags. Think carefully about what fields are necessary, and especially which ones you mark as required.
### Writing for translation
* Use active voice.
* Avoid double negatives.
* Do not use contractions as they cheapen the content and provide difficulty for readers that do not speak English of other languages.
* Avoid using synonyms for the same word in a single piece of writing.
* Write briefly, but do not sacrifice clarity for brevity. You may need to repeat or add words to make the meaning of your sentences clear to a translator.
* Avoid slang, idioms, and cliches.
* Avoid unnecessary abbreviations.
## Writing Goals and Principles
With every piece of content we publish, we aim to:
@ -60,7 +91,7 @@ We strive to have the same voice all the time, but our tone changes to suit the
Agaric's voice is:
* Straightforward and earnest.
* Unafraid of bold, perhaps visionary, calls to action.
* Unafraid of bold and even visionary calls to action.
* Irreverant; the human condition is too serious to take anything too seriously.
### Tone
@ -75,15 +106,9 @@ Agaric has a sense of humor, so feel free to be funny when it is appropriate and
We have been saying it from the beginning and are only half-serious about it.
## Writing about people
## Writing About People
We write the same way we build software: with a person-first perspective. Being aware of the impact of language is one way for us to live out our [values](values.md).
* Do not reference age or ability unless it is immediately relevant.
* Avoid gendered language and use the singular they.
* When writing about a person, use their preferred pronouns; if you do not know those, use their name.
Write for and about other people in a way that is compassionate, inclusive, and respectful.
We write the same way we build software: with a person-first perspective. Whether writing for an internal or external audience, write for and about other people in a way that is compassionate, inclusive, and respectful. Being aware of the impact of our language will help make Agaric a better place to work and a better steward of our values in the world.
### Age
@ -148,9 +173,8 @@ Use the adjective "blind" to describe a person who is unable to see. Use "low vi
## Grammar and mechanics
Adhering to certain rules of grammar and mechanics helps us keep our writing clear and consistent. This section will lay out our house style, which applies to all of our content unless otherwise noted in this guide. (We cover a lot in this section— search if you are looking for something in particular.)
Adhering to certain rules of grammar and mechanics helps us keep our writing clear and consistent. This section will lay out our house style, which applies to all of our content unless otherwise noted in this guide. (We cover a lot of ground in this section—the search feature will help if you are looking for something in particular.)
(grammar-and-mechancis-basics)=
### Basics
Write for all readers. Some people will read every word you write. Others will just skim. Help everyone read better by grouping related ideas together and using descriptive headers and subheaders.
@ -195,15 +219,18 @@ One exception is when you want to specifically emphasize the action over the sub
#### Capitalization
Sentence case capitalizes the first letter of the first word. We use sentence case for headlines, subheads, and headings as well as every other sentence. (We do **not** use title case, which capitalizes the first letter of every word except articles, prepositions, and conjunctions. Instead, we let the formatting of titles carry the weight and use the more natural sentence case.)
We use a few different forms of capitalization. Title case capitalizes the first letter of every word except articles, prepositions, and conjunctions. We use title case for the titles of pages, including blog posts and basic pages.
Sentence case capitalizes the first letter of the first word.
When writing out an e-mail address or website URL, use all lowercase.
micky@agaric.coop
micky@agaric.com
agaric.com
Do not capitalize words in the middle of sentences that are not proper nouns. We do not capitalize internet, web, or e-mail. For more, see the [word list](#word-list-specialized-vocabulary).
Do not capitalize random words in the middle of sentences. Here are some words that we never capitalize in a sentence. For more, see the Word list.
website
internet
online
e-mail
#### Contractions
@ -229,25 +256,25 @@ Numbers over 3 digits get commas:
1,000
150,000
Write out big numbers in full. Abbreviate them if there are space restraints, as in a microblog post or a chart: 1k, 150k.
Write out big numbers in full. Abbreviate them if there are space restraints, as in a tweet or a chart: 1k, 150k.
#### Dates
Generally, spell out the day of the week and the month. Abbreviate only if space is an issue.
Generally, spell out the day of the week and the month. Abbreviate only if space is an issue in the app.
Saturday, January 24
Sat., Jan. 24
#### Decimals and fractions
Spell out fractions.
No: 2/3
Yes: two-thirds
No: 2/3
Best: ⅔
Use decimal points when a number can’t be easily written out as a fraction, like 1.375 or 47.2.
#### Percentages
This depends on context— use the % symbol or spell out "percent" depending on which looks best.
This depends on context - use the % symbol or spell out "percent" depending on which looks best.
#### Ranges and spans
@ -300,7 +327,6 @@ the 90s
When referring to decades more than 100 years ago, be more specific:
the 1650s
the 1890s
the 1910s
#### Punctuation
@ -339,16 +365,15 @@ Otherwise, use common sense. If you are unsure, read the sentence out loud. Wher
Use a hyphen (-) without spaces on either side to link words into single phrase
* first-time user
* up-to-date software
To indicate a span or range, use an n-dash (–).
* Monday–Friday
Use an em dash (—) with a space after the dash to offset an aside. Use a true em dash, not hyphens (- or --). If the set-off phrase has the main part of the sentence continuing, do not include spaces around the em dash. If the set-off phrase ends the sentence, leave a space after the em dash.
Use an em dash (—) with a space after the dash to offset an aside. Use a true em dash, not hyphens (- or --).
* We could build immensely powerful movements from the ground up, if we had a way to agree how shared resources of movements—including communication channels—would be controlled.
* Migrate does almost all the work for us— we just need to create a Migration class and configure it using the constructor.
* Multivariate testing—just one of our new Pro features—can help you grow your business.
* Austin thought Brad was the doughnut thief, but he was wrong— it was Lain.
##### Ellipses
@ -396,7 +421,7 @@ Use single quotation marks for quotes within quotes.
##### Semicolons
Go easy on semicolons; they usually support long, complicated sentences that could be simplified. Try an em dash (—) instead, or simply start a new sentence.
Go easy on semicolons; they usually support long, complicated sentences that could be simplified. Try an em dash (—) instead, or simply start a new sentence.
##### Ampersands
@ -410,25 +435,23 @@ Do not use ampersands unless one is part of a company or brand name.
When referring generally to a file extension type, use all uppercase without a period. Add a lowercase s to make plural.
* GIF
* PDF
* PNG
* HTML
* JPGs
When referring to a specific file, the filename should be lowercase:
* slowclap.gif
* agaric-example-org-website-proposal.pdf
* micky-twitter-profile.jpg
```{seealso}
Agaric's [document versioning and filename conventions]().
```
* ben-twitter-profile.jpg
##### Pronouns
If your subject's gender is unknown or irrelevant, use "they," "them," and "their" as a singular pronoun. Use "he/him/his" and "she/her/her" pronouns as appropriate. Do not use "one" as a pronoun.
If your subject's gender is unknown or irrelevant, use "they," "them," and "their" as a singular pronoun. Use "he/him/his" and "she/her/her" pronouns as appropriate. Do not use "one" as a pronoun.
```{seealso}
For more on writing about gender, see [Writing about people](#writing-about-people).
For more on writing about gender, see [Writing about people](writing-about-people).
```
##### Quotations
@ -445,7 +468,7 @@ Marketing team
Support department
Capitalize individual job titles when referencing to a specific role. Do not capitalize when referring to the role in general terms.
Our new Marketing Manager starts today.
All the managers ate doughnuts.
All the managers ate donuts.
Do not refer to someone as a “guru,” “rockstar,” or “wizard” unless they literally are one.
**Schools**
@ -493,8 +516,8 @@ Do not use underline formatting, which typically indicates a link, and do not us
## Write positively
Use positive language rather than negative language. One way to detect negative language is to look for words like "cannot" or "do not" (or the contractions we want to remove anyway, "can't" and "don't").
Yes: To get a doughnut, go to the kitchen.
No: You can't get a doughnut if you don't go to the kitchen.
Yes: To get a donut, stand in line.
No: You can't get a donut if you don't stand in line.
## Content Types
@ -581,13 +604,11 @@ Example: Agaric Launches Data Visualization Platform for Healthcare Providers
Every piece of content we publish is supported by a number of smaller pieces. This section lays out our style in regards to these web elements, and explains our approach to the tricky art of SEO.
(web-elements-guidelines)=
### Guidelines
#### Alt text
Alt text is a way to label images, and it is especially important for people who can’t see the images on our website. Alt text should describe the image in a brief sentence or two.
For more on how and why we use alt text, read the [Accessibility section](#writing-for-accessibility).
For more on how and why we use alt text, read the Accessibility section.
#### Buttons
@ -628,19 +649,18 @@ Use title case, unless the heading is a punctuated sentence. If the heading is a
#### Links
Provide a link when you refer to anything web-accessible that is relevant and hosted by a trusted external resources.
Provide a link whenever you’re referring to something on an external website. Use links to point users to relevant content and trusted external resources.
Do not include preceding articles (a, an, the, our) when you link text. For example:
Yes: Read the [content style guide](content-style-guide.md#links) for details.
No: Read [the content style guide](content-style-guide.md#links) for details.
Yes: Read the [content style guide](content-style-guide#links) for details.
No: Read [the content style guide](content-style-guide#links) for details.
If a link comes at the end of a sentence or before a comma, do not link the punctuation mark.
If a link comes at the end of a sentence or before a comma, don’t link the punctuation mark.
Do not say things like "Click here!" or "Click for more information" or "Read this." Write the sentence as you normally would, and link relevant keywords.
Do not say things like “Click here!” or “Click for more information” or “Read this.” Write the sentence as you normally would, and link relevant keywords.
Links should look different than regular copy, strong text, or emphasis text. They should have a hover state that communicates they are interactive, and should have a distinct active and visited state. When setting the hover state of links, be sure to include focus state as well, to help readers using assistive technologies and touch devices.
```{seealso}
[Baseline Styleguide: Links](making-websites/baseline-styleguide.md#links)
```
#### Lists
@ -686,7 +706,7 @@ Give every image descriptive alt text.
Agaric blog posts are written by people from all over the company, not just those with “writer” in their job titles. We love having people who know the most about what they do blog about their work. The person most familiar with the subject is in the best position to convey it, and other Agarics can help with brainstorming and editing as needed.
(writing-blog-posts-basics)=
### Basics
We update the main Agaric blog a couple times every month. We generally publish:
@ -872,7 +892,7 @@ People should be able to keep up with Agaric however they choose, so we should i
### Guidelines
E-mail newsletters use our [voice and tone](#voice-and-tone) and follow our [grammar and mechanics](#grammar-and-mechanics), in addition to these newsletter-specific considerations.
E-mail newsletters use our [voice and tone](#id1) and follow our [grammar and mechanics](grammar-and-mechanics), in addition to these newsletter-specific considerations.
### Consider all elements
@ -947,7 +967,7 @@ Agaric has a presence on most major social media platforms. Here are our most ac
### Guidelines
Our writing for social media should generally follow the style points outlined in the [Voice and tone](#voice-and-tone) and [Grammar and mechanics](#grammar-and-mechanics) sections. Here are some additional pointers.
Our writing for social media should generally follow the style points outlined in the [Voice and tone](#id1) and [Grammar and mechanics](#id3) sections. Here are some additional pointers.
#### Write concisely, but clearly
@ -985,9 +1005,8 @@ We employ hashtags rarely and deliberately. We may use them to promote an event
## Writing for Accessibility
We are always working to make our content more accessible and usable to the widest possible audience. Writing for accessibility goes way beyond making everything on the page available as text. It also affects the way you organize content and guide readers through a page. Depending on the audience and country, there may be laws governing the level of accessibility required. At minimum, an accessible version should be available. Accessibility includes users of all mental and physical capacities, whether situational (broken glasses, circling helicopters) or more permanent.
We are always working to make our content more accessible and usable to the widest possible audience. Writing for accessibility goes way beyond making everything on the page available as text. It also affects the way you organize content and guide readers through a page. Depending on the audience and country, there may be laws governing the level of accessibility required. At minimum, an accessible version should be available. Accessibility includes users of all mental and physical capacities, whether situational (broken glasses!) or more permanent.
(accessibility-basics)=
### Basics
We write for a diverse audience of readers who all interact with our content in different ways. We aim to make our content accessible to anyone using a screen reader, keyboard navigation, or Braille interface, and to users of all cognitive capabilities.
@ -1002,16 +1021,6 @@ As you write, consider the following:
Many of the best practices for writing for accessibility echo those for writing technical content, with the added complexity of markup, syntax, and structure.
* Some people will read every word you write. Others will scan. Help everybody by grouping related ideas together and by using descriptive headers and subheaders.
* Create a hierarchy, with the most important information first.
Place similar topics in the same paragraph, and clearly separate different topics with headings.
* Use plain language. Write short sentences and familiar words.
* Links should provide information on the associated action or destination. Avoid writing "click here" or "learn more."
* Avoid using images when descriptive text will do.
* Avoid directional instructions or language that requires the reader to see the layout or design of the page.
* Label inputs on forms with clear names and use appropriate tags. Think carefully about what fields are necessary, and especially which ones you mark as required.
(accessibility-guidelines)=
### Guidelines
* Avoid directional language
@ -1048,13 +1057,13 @@ Write short sentences and use familiar words. Avoid jargon and slang. If you nee
### Use alternative text
The alt tag is the most basic form of image description, and it should be included on all images. The wording will depend on the purpose of the image:
The alt tag is the most basic form of image description, and it should be included on all images. The language will depend on the purpose of the image:
* If it is a creative photo or supports a story, describe the image in detail in a brief caption.
* If the image is serving a specific function, describe what is inside the image in detail. People who do not see the image should come away with the same information as if they had.
* If you are sharing a chart or graph, include the data in the alt text so people have all the important information.
Supplement images with standard captions when you realize .
Each browser handles alt tags differently. Supplement images with standard captions when possible.
### Make sure closed captioning is available
@ -1066,7 +1075,6 @@ Aim for high contrast between your font and background colors. Tools in the reso
Images should not be the only method of communication, because images may not load or may not be seen. Avoid using images when the same information could be communicated in writing.
(accessibility-resources)=
### Resources
* [Accessibility evaluation for web writers](http://www.4syllables.com.au/2013/05/writers-accessibility-evaluation/)
@ -1076,19 +1084,10 @@ Images should not be the only method of communication, because images may not lo
## Writing for Translation
* Use active voice.
* Avoid double negatives.
* Do not use contractions as they cheapen the content and provide difficulty for readers that do not speak English of other languages.
* Avoid using synonyms for the same word in a single piece of writing.
* Write briefly, but do not sacrifice clarity for brevity. You may need to repeat or add words to make the meaning of your sentences clear to a translator.
* Avoid slang, idioms, and cliches.
* Avoid unnecessary abbreviations.
Agaric serves users in several countries and territories, not just the United States. As our user base grows, it becomes more and more important that our content is accessible to people around the world.
We call the process of writing copy for translation "internationalization." This section will address things you can do to help international audiences, including translators, better comprehend your text.
(writing-for-translation-basics)=
### Basics
We try to write all of our content in standard, straightforward English that can be understood by users with limited English proficiency. It is much easier for a translator to clearly communicate ideas written in straightforward, uncomplicated sentences.
@ -1103,10 +1102,9 @@ Use positive words when talking about positive situations. For example, because
Avoid contractions.
(writing-for-translation-guidelines)=
### Guidelines
When writing for international audiences, we generally follow what is outlined in the Voice and tone and [Grammar and mechanics](#grammar-and-mechanics) sections. But in this section more than others, some style points contradict what is stated elsewhere in the guide. If you are writing something to be translated, the guidelines in this section should take precedence.
When writing for international audiences, we generally follow what is outlined in the Voice and tone and Grammar and mechanics sections. But in this section more than others, some style points contradict what is stated elsewhere in the guide. If you are writing something to be translated, the guidelines in this section should take precedence.
#### Consider cultural differences
@ -1191,31 +1189,31 @@ No: From our backyard, we could hear the planes taking off from the airport.
* Slang, idioms, and cliches
* Contractions (English contractions may be harder to translate)
* Shortened words, even if they are common in English (use "application," not "app")
* Uncommon foreign words (use "genuine," not "bona fide")
* Unnecessary abbreviations (use "for example," not "e.g.")
* Verbing nouns (or otherwise converting one part of speech into another) if the usage is not common (use "Send us an e-mail" instead of "message us")
* Non-standard or indirect verb usage (use "he said," not "he was like" or "he was all")
* Shortened words, even if they are common in English (use “application,” not “app”)
* Uncommon foreign words (use "genuine,” not “bona fide”)
* Unnecessary abbreviations (use "for example,” not “e.g.”)
* Converting one part of speech into another if it isn’t already commonly used (use "Send us an e-mail” instead of “message us”)
* Non-standard or indirect verb usage (use “he says,” not “he’s like” or “he was all”)
* Double negatives
* Using multiple different words for the same thing in a single piece of writing. Instead of mixing it up with "campaign," "newsletter," "bulletin," etc., pick one term and stick with it.
* Synonyms, generally. Do not use a lot of different words for the same thing in a single piece of writing. Instead of mixing it up with “campaign,” “newsletter,” “bulletin,” etc., pick one term and stick with it.
#### Beware words with multiple meanings
"Once" (could mean "one time," "after," "in the past," or "when")
No: Once you log in, you will see your account's dashboard.
Yes: After you log in, you will see your account's dashboard.
“Once” (could mean “one time,” “after,” “in the past,” or “when”)
Yes: After you log in, you will see your account's Dashboard.
No: Once you log in, you will see your account's Dashboard.
"Right" (could mean "correct," "the opposite of left," or "reactionary")
No: Click the right image and drag it to the right pane.
Yes: Click the correct image and drag it to the pane at right.
“Right” (could mean “correct,” “the opposite of left,” “politically conservative,” etc.)
Yes: In the File Manager, click the correct image and drag it to the pane at right.
No: In the File Manager, click the right image and drag it to the right pane.
"Since" (could refer to a point in time, or a synonym of "because")
No: Since you already registered, this information will be filled out for you.
Yes: Because you already registered, this information will be filled out for you.
“Since” (could refer to a point in time, or a synonym of “because”)
Yes: Because you already have a complete mailing list, you can send your campaign at any time.
No: Since you already have complete mailing list, you can send your campaign at any time.
"Require to" (could confuse the relationship between subject and object)
No: A registered account is required to post to the forum. (This could imply that people with paid accounts are required to send autoresponders.)
Yes: An account
“Require” plus an infinitive (could confuse the relationship between subject and object)
Yes: Autoresponders can be configured and sent from paid accounts.
No: A paid account is required to send autoresponders. (This could imply that users with paid accounts are required to send autoresponders.)
“Has” or “have” plus past participle (could confuse the relationship between subject and object)
Yes: The folder contains sent campaigns.
@ -1227,9 +1225,9 @@ No: The folder has sent campaigns.
When writing for an international audience, use the metric system. Spell out all units and avoid abbreviation.
**Currency**
Many countries call their currency "the dollar," but the value is going to differ between countries. The US dollar is not the same as the Canadian dollar, for example. So it is important to specify.
Many countries call their currency "the dollar," but the value is going to differ between countries. The US dollar is not the same as the Canadian dollar, for example. So it’s important to specify.
Avoid colloquial phrases that relate to money, like "five-and-dime," "greenbacks," or "c-notes." These will not translate well.
Avoid colloquial phrases that relate to money, like “five-and-dime,” “greenbacks,” or “c-notes.” These will not translate well.
## Word list (specialized vocabulary)
@ -1289,6 +1287,13 @@ Originally adapted from [Mailchimp's content style guide](https://styleguide.mai
* [Marketing documentation](marketing).
* Information about [copyrights and trademarks](copyright-and-trademarks).
* [Baseline Styleguide](making-websites/baseline-styleguide.md)
* [Agaric website basics](agaric-website/basics) and [content entry on Agaric's sites](agaric-website/agaric-site-content-entry).
```
```{toctree}
---
caption: See also
---
copyright-and-trademarks
```

41
copyright-and-trademarks.md
View file

@ -10,43 +10,34 @@ Copyright protection begins when the work is first created and it doesn’t requ
Copyright notice on the work is not required but it is recommended, since it cuts off a defense of innocent infringement.
### Copyright at Agaric
We default to a Creative Commons license whenever possible.
### Other creators’ copyrights
We respect the copyright of other creators. If we want to use someone else’s copyrighted work, we have to obtain a license from the owners.
A copyright license spells out these terms:
Where we can use the work
How long we can use it for
How much we’ll pay them for the use
Whether or not we’re the only ones who can use the work
What we can do with the work
Any restrictions on our use (for example, that we can use it online but not on a billboard)
A common license will read something like this:
“You grant Agaric a perpetual, worldwide, non-exclusive, royalty free license to display, distribute, and publish the Work in our marketing in any medium now known or later developed.”
We respect the copyright of other creators. If we want to use someone else's copyrighted work, we have to obtain a license from the owners.
A copyright license spells out these terms:
- Where we can use the work
- How long we can use it for
- How much we'll pay them for the use
- Whether or not we’re the only ones who can use the work
- What we can do with the work
- Any restrictions on our use (for example, that we can use it online but not on a billboard)
For example:
"You grant Agaric a perpetual, worldwide, non-exclusive, royalty free license to display, distribute, and publish the Work in our marketing in any medium now known or later developed."
### Social media and copyright
This is an area where the letter of the law and common practice sometimes differ.
Social media posts often include copyrighted elements like pictures, GIFs, or pieces of writing. If you’re using a copyrighted element in a commercial manner on social media, you should request permission from the copyright holder. Since Agaric is a company, we defer to the position that our use will be perceived as commercial. But if you’re using it in a more informative or commentary way, like sharing a meme to indicate how you feel about a news story, you may not need to request permission.
Regardless, you should always link to the source of the copyrighted element you’re using, and never make it look like you created work that belongs to someone else.
### Image use and copyright
Agaric oftentimes uses original images in our blog posts. If you use an image, photo, or other design element made by someone outside Agaric, get permission first. Once you have permission, always give the copyright owner credit and link back to the original source.
Agaric prefers using original images in our blog posts. Ben has a lot of random images and you can check with him on subjects. We also have a relationship with [Martin Owens to commission digital vector art made with Inkscape](https://www.patreon.com/doctormo).
If you use an image, photo, or other design element made by someone outside Agaric, get permission first. Once you have permission, always give the copyright owner credit and link back to the original source.
Attribution goes for Creative Commons also, and we have an attribution field built into our website for blog posts.
Good sources of Creative Commons or open access (public domain) images include:
- Flickr: https://www.flickr.com/search/?license=4%2C5%2C6%2C9%2C10
- Smithsonian Institute: https://www.si.edu/openaccess
Images retrieved via Google image search are not licensed for fair use, but many images are available under license through stock photo websites, or open for use under a Creative Commons license. Flickr has a great search feature for images available under Creative Commons licenses.
### Other licenses
#### Creative Commons licenses
Instead of the standard “all rights reserved,” some creators choose to make their work available for public use with different levels of attribution required. That’s what we’ve done with this style guide. Find a breakdown of licenses on the Creative Commons website.
We love to share our work and use these licenses frequently.

24
days-off.md
View file

@ -1,24 +0,0 @@
# Days off
Collective-wide holidays.
Federal holidays:
* New Year's Day
* Martin Luther King Jr. Day
* Presidents' Day
* Memorial Day
* Juneteenth
* Independence Day
* Labor Day
* Columbus Day
* Armistice Day (kids these days call it Veterans Day)
* Thanksgiving Day
* Christmas Day
And the real labor day:
* May First
Source: [opm.gov/policy-data-oversight/pay-leave/federal-holidays](https://www.opm.gov/policy-data-oversight/pay-leave/federal-holidays/)
Given that most of these move around year to year to be the closest Monday, we have added the .ics file OPM provided (goes through 2030) to the [Agaric shared calendar](calendars) via Thunderbird's "Events & Tasks » Import".

2
decision-making.md
View file

@ -21,6 +21,6 @@ Choose facilitator at start of meeting, or by predetermined system
Facilitator's job is to keep things moving.
Someone other than the facilitator should be designated for taking notes, but everyone can help (we will always do meeting notes on a text pad allowing real-time collaborative note-taking, such as [Etherpad](https://etherpad.org/), the shared notes built into [Big Blue Button](https://bigbluebutton.org/), or [HedgeDoc](https://hedgedoc.org/) (this is our current main tool for notes, which we self-host).
Someone other than the facilitator should be designated for taking notes, but everyone can help (we will always do meeting notes on a text pad allowing real-time collaborative note-taking, such as [Etherpad](https://etherpad.org/).
See template at [worker-owner meeting](worker-owner-meeting).

41
documentation.md
View file

@ -2,7 +2,7 @@
Welcome to the meta section of our documentation where we document how to do documentation!
Edit or add. That's the primary instruction. You can edit directly on [gitlab.com/agaric/documentation](https://gitlab.com/agaric/documentation) (for example, the edit link on this page takes you to [gitlab.com/agaric/documentation/blob/main/documentation.md](https://gitlab.com/agaric/documentation/blob/main/documentation.md)). If you aren't a member of Agaric, GitLab will helpfully offer to fork the documentation to your own namespace so that you can make a merge request with your documentation suggestion.
Edit or add. That's the primary instruction. You can edit directly on [gitlab.com/agaric/documentation](https://gitlab.com/agaric/documentation) (for example, the edit link on this page takes you to [gitlab.com/agaric/documentation/blob/master/documentation.md](https://gitlab.com/agaric/documentation/blob/master/documentation.md)). If you aren't a member of Agaric, GitLab will helpfully offer to fork the documentation to your own namespace so that you can make a merge request with your documentation suggestion.
```{tip}
This documentation page is a good one to copy or refer to for an example of MyST formatting. And of course anyone can come and clean up formatting later.
@ -15,7 +15,7 @@ We like [Gitlab's approach](https://about.gitlab.com/handbook/git-page-update/#w
Somewhere is better than nowhere.
Don't worry about [translation](translation.md).
Don't worry about [translation](translation).
## Guidelines
@ -25,51 +25,22 @@ Don't worry about [translation](translation.md).
* Topics which are of general application can be abstracted, put in this repository, and linked to at this documentation.
```{note}
In doing documentation we are living our [values](values.md) of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships.
In doing documentation we are living our [values](values) of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships.
```
## This documentation
## Local preview
* Written primarily in Markdown, enhanced by Sphinx.
* Uses the [MyST parser for cross-referencing](https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html).
### Local preview
#### Setup
### Setup
```bash
sudo apt install python3-sphinx
pip3 install -r requirements.txt
```
#### Generating
### Generating
Running this documentation locally:
```bash
sphinx-build -b html . _build/html
```
### Useful examples
#### Including the table of contents of another page
```
```{toctree}
---
caption: See also
---
copyright-and-trademarks
```
```
Produces this:
```{toctree}
---
caption: See also
---
copyright-and-trademarks
```

14
friday-review-and-planning.md
View file

@ -1,7 +1,7 @@
# Friday Shipping Meeting
```md
# 2023 {Date}, Friday shipping
# 2021 {Date}, Friday shipping
## Major Accomplishments/Hurdles Cleared?
@ -22,9 +22,17 @@
### Micky
*
### Louis
### Sanjay
*
### Hours Entered
* Ben -
* Chris -
* Keegan -
* Mauricio -
* Micky -
* Sanjay -
## Availability
@ -45,5 +53,5 @@
* Keegan -
* Mauricio -
* Micky -
* Louis
* Sanjay -
```

5
growth.md
View file

@ -1,5 +0,0 @@
# Growing Agaric
As a mushroom, Agaric has several options for growth. We don't want to become [the largest organism on the planet](https://www.scientificamerican.com/article/strange-but-true-largest-organism-is-fungus/) so our approach is [mitosis](https://www.sciencedirect.com/science/article/abs/pii/S0074769608600790)— dividing.
If or when Agaric grows to more than about a dozen worker-owners, we plan to split into two equal groups, opearting under the banner of Agaric and sharing resources, but federating as small worker cooperatives rather than changing our basic internal structure to scale.

BIN
images/AgaricForgejo-only-email-on-mention.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 51 KiB

BIN
images/choose-caldav-and-calendar.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 38 KiB

BIN
images/choose-calendars-to-import.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 50 KiB

BIN
images/import-all-calendars.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 32 KiB

BIN
images/mayfirst-specific-calendar.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 33 KiB

47
index.md
View file

@ -32,11 +32,9 @@ maxdepth: 2
roles
intra-team-communication
lead-communication
calendars
project-management-with-gitlab
weekly-rhythm
days-off
```
@ -47,63 +45,42 @@ maxdepth: 2
---
tools/git-setup
tools/git-usage
tools/setting-up-nextcloud
tools/securely-sending-files-nextcloud
tools/setting-up-email
tools/big-blue-button
tools/recommended-local-project-locations
tools/creating-new-drutopia-site
tools/deploying-drutopia-updates
tools/ddev-local-development-environment
tools/drutopia-member-server-access
tools/upgrading-drutopia-platform-elizabeth-sites
tools/uptime-monitoring
tools/inspecting-logs
templates/drupal-module-project
tools/bookkeeping-with-gnucash
```
```{toctree}
---
caption: Writing for Agaric
caption: Agaric.coop
maxdepth: 2
---
content-style-guide
agaric-website/basics
agaric-website/agaric-site-content-entry
agaric-website/tags-and-taxonomy-terms
agaric-website/translation
agaric-website/short-urls
```
```{toctree}
---
caption: Important other topics
maxdepth: 2
---
content-style-guide
marketing
copyright-and-trademarks
```
```{toctree}
---
caption: How We Work
maxdepth: 2
---
decision-making
growth
client-communication/document-versioning-filenames
```
```{toctree}
---
caption: Documentation
maxdepth: 2
---
reference-docs
documentation
shared-technical-notes
reference-docs
```
---
If you've found your here way to Agaric's internal documentation but don't know about the [Agaric technology collective](https://agaric.coop/) itself yet, please check out our [development and consulting services](https://agaric.coop/services), [our trainings](https://agaric.coop/training), and [our initiatives](https://agaric.coop/initiatives) or read [about Agaric](https://agaric.coop/about-agaric) and [ask us for help or collaboration](https://agaric.coop/ask).

124
intra-team-communication.md
View file

@ -17,7 +17,7 @@ Our primary tool for internal communication is now [Zulip](https://zulipchat.com
### E-mailing messages to Zulip
When BCCing a Zulip stream on a message to someone, Use the default that can be found under stream settings. First press 'Channel settings' menu item in 'Main menu' (gear icon in top right), then filter for your channel and finally press the 'Generate email address' to reveal the address. Although the button says 'Generate email address' the same addresses are used so it is more a revelation than a generation:
When BCCing a Zulip stream on a message to someone, Use the default that can be found under stream settings (click the gear icon you can get to from the down caret):
```
project.785f16fc671a5d8c0f2d4fbb161f16b3.show-sender@streams.zulipchat.com
@ -29,8 +29,6 @@ When forwarding an e-mail to a Zulip stream, swap out `.show-sender` for `.inclu
project.785f16fc671a5d8c0f2d4fbb161f16b3.include-footer.include-quotes.prefer-html@streams.zulipchat.com
```
The subject of the email message will be used as the topic name in the stream.
```{info}
More about [sending a message to a Zulip stream by e-mail](https://zulipchat.com/help/message-a-stream-by-email)
```
@ -40,14 +38,31 @@ Hover over a stream in the lefthand column to get to stream settings; there's al
Stream settings pages are also key for getting the e-mail address for sending e-mail to streams, https://agaric.zulipchat.com/help/message-a-stream-by-email (their help is lightly customized to organization, so that "Your streams" link will work)
## Real-time meetings with BigBlueButton
### Zulip <-> IRC bridge
Agaric uses BigBlueButton (BBB) video chat for our daily Stand Up meetings and for client meetings. We have an account with [meet.coop](https://meet.coop) but currently primarily use our own instance, [meet.agaric.coop](https://meet.agaric.coop).
This package has been installed using (sort-of) the instructions at https://agaric.zulipchat.com/integrations/doc/irc
Regular meetings include [Monday](monday-checkin.md), [Wednesday](wednesday-checkin.md), and [Friday](friday-review-and-planning.md) [weekly rhythm meetings](weekly-rhythm.md). More irregular meetings include as-needed [worker-owner meetings](worker-owner-meeting.md).
The bot currently lives on irc.agaric.com under the zulip account with software at /srv/zulip.
To launch the bot, login as root, and then:
```
su - zulip # become user for bot for agaric
startzulip
ctrl+d # switch back to root
su - zulip-nichq # become user for bot for nichq
startzulip
```
This should start zulip in the background and you can now disconnect. If there are errant processes, use `ps aux|grep zulip` to locate PIDs and `kill {pid}` of each. Also, you can `kick bot_zulip` on IRC if you are an IRC operator, which should also kill an existing process.
## BBB - BigBlueButton video chat
Agaric uses BigBlueButton for our daily Stand Up meetings and for client meetings. We have an account with http://meet.coop and you can find our room is here: https://ca.meet.coop/b/aga-52x-qa8
## IRC
\#agaric
Agaric also maintains a channel for worker-owners only. NOTE: We have not been using IRC sine Zulip arrived, but some of us still hang out there and use it to connect with other developers that are not in Zulip.
@ -61,6 +76,103 @@ Freenode has given us operator privileges for this channel. To use it, we need
Some of our best clients are also on IRC, as are our partners at [May First Movement Technology (#mayfirst on irc.indymedia.org)](https://support.mayfirst.org/wiki/faq/chat).
### IRC Bouncer ###
**This is currently not active. There is an admin account installed/configured, but not auto-starting, and currently not running. If any member wants to restore the service for themselves, feel free!**
In order to acquire a 1.7 edition of ZNC, the backports for stretch were added and utilized for this package.
ZNC 1.7 is an IRC bouncer listening on port 1025 of irc.agaric.com.
A web interface is available for management at: https://irc.agaric.com:1025 that enables module maintenance, etc.
The entire app runs under the local system user znc-admin (just run `znc` as the znc-admin user).
### Web-based IRC client: The Lounge
We can access our IRC (and any other IRC) through:
https://irc.agaric.com
#### The Lounge Management
[The Lounge is a self-hosted web IRC client](https://thelounge.github.io/) we're using to provide https://irc.agaric.com
Everyone in [SSH_public_keys](https://gitlab.com/agaric/internal/-/wikis/SSH-Public-Keys) as of 2017 August has access to the Digital Ocean droplet (1cpu/512mb) hosting it:
`ssh root@irc.agaric.com`
##### Upgrading
TheLounge is installed manually via dpkg as there is no current apt source for it.
To upgrade via dpkg:
- Go to https://github.com/thelounge/thelounge/releases/ and select your release
- Copy the link to the deb file at the bottom of the releases page.
- `ssh root@irc.agaric.com` and run `wget -L -o thelounge.deb <copied link>`
- Install the new package with `dpkg -i thelounge.deb`
- The service should restart, but if it does not, `systemctl restart thelounge`
There is also an option to use `thelounge update` but it is unclear if this is preferable to using dpkg.
##### Configuration
TheLounge is bound to the loopback address at port 9000 and reverse proxied via NGINX. The configuration and user files are located at `/srv/lounge/`. The configuration is pointed at via an Environment variable (the variable can be inspected/changed via `systemctl edit thelounge`).
##### TLS(/SSL)
NGINX will bounce HTTP connections to HTTPS and handle encryption via reverse proxy. Certbot is installed and should be handling automatic renewals with reload of NGINX as needed.
##### Management
Note that because the ENV var is depended upon for our configuration, and it runs as thelounge user. In order to facilitate simpler management, an alias is defined for thelounge under the root account.
This is configured for you (as root):
```
alias thelounge='sudo -u thelounge THELOUNGE_HOME=/srv/lounge thelounge'
```
List users:
```
thelounge list
```
Addin a user:
```
thelounge add username
```
Where `username` is the IRC nick for the user you are adding.
reset pwd:
```
thelounge reset username
```
Additional management commands can be found in [TheLounge documentation](https://thelounge.chat/docs/users).
### IRC Bot (Limnoria aka Supybot)
#### History
Stefan Freudenberg selected and installed Supybot as Agaric's general-purpose information bot (in particular expanding issue numbers to issue titles) circa 2010. Early in 2018 Chris Thompson upgraded Supybot — "a robust (it doesn't crash), user friendly (it's easy to configure) and programmer friendly (plugins are extremely easy to write) Python IRC bot. It aims to be an adequate replacement for most existing IRC bots. It includes a very flexible and powerful ACL system for controlling access to commands, as well as more than 50 builtin plugins providing around 400 actual commands" — to Limnoria — a project which continues development of Supybot.
It is installed on Simone.
#### Common commands
@later tell username A message
(until we override @tell to use the far more useful 'later' flavor)
#### Official documentation
* https://github.com/ProgVal/Limnoria
* http://doc.supybot.aperio.fr/en/latest/index.html
## Internal notes
Agarics can get more detail [on communication channels in the wiki](https://gitlab.com/agaric/internal/wikis/Communication-Channels).

4
lead-communication.md
View file

@ -1,4 +0,0 @@
# Lead communication
## Trainings
For members of Agaric, tips on what needs to be communicated with people who have requested training can be found here: [Training leads communication document](https://gitlab.com/agaric/trainings)

11
making-websites/baseline-styleguide.md
View file

@ -1,11 +0,0 @@
# Baseline Styleguide
A styleguide with no style of its own, but nevertheless providing the basic requirements any look-and-feel guidelines must conform to.
```{seealso}
For writing (rather than presentation), see [Agaric's Content Style Guide](/content-style-guide.md).
```
## Links
Links should look different than regular text, strong text, or emphasized text. They should have a hover state that communicates they are interactive, and should have a distinct active and visited state. When setting the hover state of links, be sure to include focus state as well, to help readers using assistive technologies and touch devices.

58
monday-checkin.md
View file

@ -10,7 +10,7 @@ The Monday checkin ensures everyone is on the same page starting the week. It i
Here is a template that can be pasted into a text pad (ideally markdown-aware).
```md
# 2024 MONTH XXth – Monday Checkin
# 2021 MONTH XXth – Monday Checkin
## Checkins
@ -19,54 +19,27 @@ Here is a template that can be pasted into a text pad (ideally markdown-aware).
* Mauricio
* Chris
* Micky
* Sanjay
* Ben
* Keegan
* Louis
* Dave
## Leads, or important projects
*Remember to discuss scheduling for any leads meetings*
### Hours Entered (previous week)
* Ben -
* Chris -
* Keegan -
* Mauricio -
* Micky -
* Louis -
* Dave -
## Pair programming avilability for the week
* Ben -
* Chris -
* Keegan -
* Mauricio -
* Micky -
* Louis -
* Dave -
* Drutopia Office Hours - anything to do with Nedjo this week?
### Project assignments
* MASS Design Group - MASS Continuous Improvement (Ben/Dave)
* Tulane - Therapy Fidelity App (Chris/Keegan)
* Spry Group - Type Network (Keegan/Chris)
* Agaric e.K. - C-Team support (Zeit) (Mauricio/Ben)
* Action Information - Green Calendar (Sanjay/Chris)
* BMOP - bmop.org site upgrade (Keegan/Mauricio)
* Portside - Portside (Ben/Chris)
* UC Irvine - PECE (Ben/Keegan)
* Vermont Housing Finance Agency - VHFA (Chris/Ben)
* HousingWorks, Inc. - HousingWorks (Louis/Ben)
* Teachers with GUTS - Project GUTS/TWIG/Making Sense of Models (Ben/Louis)
* Sahara Reporters - Sahara Reporters site migration (Ben/Sanjay)
* NC Housing Finance Agency - NCHFA Maintenance (Louis/Ben)
* Agaric e.K. - C-Team support (Zeit) (Mauricio/Louis)
* UPenn - Jacket2 Upgrade to D10 (Mauricio/Keegan)
* Kalamuna - Outsourcing (Mauricio/Ben)
* CRLA - CRLA.org Development & Support (Keegan/Ben)
* Action Information - Green Calendar (Sanjay/Louis)
* Grassroots Economic Organizing (GEO) - GEO Support (Ben/Louis)
* Eliot School of Fine & Applied Arts - Eliot School Site & CRM (Keegan/Ben)
* DrupalEasy.com - Training assistance (Mauricio/Keegan)
* CRLA - CRLA.org Development & Support (Ben/Keegan)
* Eliot School of Fine & Applied Arts - Eliot School Site & CRM (Ben/Keegan)
* MASS Design Group - MASS Continuous Improvement (Ben/Keegan)
* Grassroots Economic Organizing (GEO) - GEO Support (Micky/Ben)
* UC Davis - Patient HM Brain Science Website (Sanjay/Keegan)
Only listed @ score of 2+ for others see https://share.mayfirst.org/f/11573025
@ -78,7 +51,8 @@ Only listed @ score of 2+ for others see https://share.mayfirst.org/f/11573025
* Sanjay
* Ben
* Keegan
* Louis
## Availability
## Task allocation

17
official/certificate-of-organization.md
View file

@ -1,17 +0,0 @@
# Certificate of Organization
Agaric Technology Collective's Certificate of Organization filed with the Commonwealth of Massachusetts (most states call the equivalent document "Articles of Organization") reads:
> 1. The exact name of the limited liability company is: **AGARIC, LLC**
> 3. The general character of business, and if the limited liability company is organized to render professional service, the service to be rendered:
>
> **AGARIC HELPS PEOPLE CREATE AND USE ONLINE TOOLS AND PLATFORMS THAT MEET
THEIR AND THEIR COMMUNITIES' NEEDS. THE COLLECTIVE GOAL IS THE MOST POWER
POSSIBLE FOR ALL PEOPLE OVER THEIR OWN LIVES, AND TOWARD THAT GOAL THE
COLLECTIVE TAKES ON WEB DEVELOPMENT PROJECTS THAT CONNECT IDEAS,
RESOURCES, AND PEOPLE. WE USE AND CONTRIBUTE TO OPEN SOURCE FREE SOFTWARE
AND ENSURE EVERYTHING WE BUILD IS FREE, AND THE WAY WE BUILD IT OPEN, FOR OUR
CLIENTS TO TRULY OWN.**
In Massachusetts, member-management is the default structure for an LLC. (Other state forms would have required choosing between member-managed and manager-managed.)

117
old/irc.md
View file

@ -1,117 +0,0 @@
# IRC
### Zulip <-> IRC bridge
This package has been installed using (sort-of) the instructions at https://agaric.zulipchat.com/integrations/doc/irc
The bot currently lives on irc.agaric.com under the zulip account with software at /srv/zulip.
To launch the bot, login as root, and then:
```
su - zulip # become user for bot for agaric
startzulip
ctrl+d # switch back to root
su - zulip-nichq # become user for bot for nichq
startzulip
```
This should start zulip in the background and you can now disconnect. If there are errant processes, use `ps aux|grep zulip` to locate PIDs and `kill {pid}` of each. Also, you can `kick bot_zulip` on IRC if you are an IRC operator, which should also kill an existing process.
### IRC Bouncer ###
**This is currently not active. There is an admin account installed/configured, but not auto-starting, and currently not running. If any member wants to restore the service for themselves, feel free!**
In order to acquire a 1.7 edition of ZNC, the backports for stretch were added and utilized for this package.
ZNC 1.7 is an IRC bouncer listening on port 1025 of irc.agaric.com.
A web interface is available for management at: https://irc.agaric.com:1025 that enables module maintenance, etc.
The entire app runs under the local system user znc-admin (just run `znc` as the znc-admin user).
### Web-based IRC client: The Lounge
We can access our IRC (and any other IRC) through:
https://irc.agaric.com
#### The Lounge Management
[The Lounge is a self-hosted web IRC client](https://thelounge.github.io/) we're using to provide https://irc.agaric.com
Everyone in [SSH_public_keys](https://gitlab.com/agaric/internal/-/wikis/SSH-Public-Keys) as of 2017 August has access to the Digital Ocean droplet (1cpu/512mb) hosting it:
`ssh root@irc.agaric.com`
##### Upgrading
TheLounge is installed manually via dpkg as there is no current apt source for it.
To upgrade via dpkg:
- Go to https://github.com/thelounge/thelounge/releases/ and select your release
- Copy the link to the deb file at the bottom of the releases page.
- `ssh root@irc.agaric.com` and run `wget -L -o thelounge.deb <copied link>`
- Install the new package with `dpkg -i thelounge.deb`
- The service should restart, but if it does not, `systemctl restart thelounge`
There is also an option to use `thelounge update` but it is unclear if this is preferable to using dpkg.
##### Configuration
TheLounge is bound to the loopback address at port 9000 and reverse proxied via NGINX. The configuration and user files are located at `/srv/lounge/`. The configuration is pointed at via an Environment variable (the variable can be inspected/changed via `systemctl edit thelounge`).
##### TLS(/SSL)
NGINX will bounce HTTP connections to HTTPS and handle encryption via reverse proxy. Certbot is installed and should be handling automatic renewals with reload of NGINX as needed.
##### Management
Note that because the ENV var is depended upon for our configuration, and it runs as thelounge user. In order to facilitate simpler management, an alias is defined for thelounge under the root account.
This is configured for you (as root):
```
alias thelounge='sudo -u thelounge THELOUNGE_HOME=/srv/lounge thelounge'
```
List users:
```
thelounge list
```
Addin a user:
```
thelounge add username
```
Where `username` is the IRC nick for the user you are adding.
reset pwd:
```
thelounge reset username
```
Additional management commands can be found in [TheLounge documentation](https://thelounge.chat/docs/users).
### IRC Bot (Limnoria aka Supybot)
#### History
Stefan Freudenberg selected and installed Supybot as Agaric's general-purpose information bot (in particular expanding issue numbers to issue titles) circa 2010. Early in 2018 Chris Thompson upgraded Supybot — "a robust (it doesn't crash), user friendly (it's easy to configure) and programmer friendly (plugins are extremely easy to write) Python IRC bot. It aims to be an adequate replacement for most existing IRC bots. It includes a very flexible and powerful ACL system for controlling access to commands, as well as more than 50 builtin plugins providing around 400 actual commands" — to Limnoria — a project which continues development of Supybot.
It is installed on Simone.
#### Common commands
@later tell username A message
(until we override @tell to use the far more useful 'later' flavor)
#### Official documentation
* https://github.com/ProgVal/Limnoria
* http://doc.supybot.aperio.fr/en/latest/index.html

178
operating-agreement.md
View file

@ -1,178 +0,0 @@
## Operating agreement for Agaric, LLC
[Note: For a corporation, these would be called bylaws.]
## ARTICLE I: Company Formation
### 1.1 FORMATION.
The Members hereby form a worker owned and run Limited Liability Company ("Collective") subject to the provisions of the Limited Liability Company Act as currently in effect as of this date, 2011 May 18. Articles of Organization shall be filed with the Secretary of the Commonwealth.
### 1.2 NAME.
The name of the Collective shall be Agaric.
### 1.3 REGISTERED AGENT.
Up-to-date information can be found at:
https://corp.sec.state.ma.us/CorpWeb/CorpSearch/CorpSummary.aspx?sysvalue=HjjIHbOP890XgjC6fWoReGpnXzMPqiTgvN_a5t8CxoA-
### 1.4 TERM.
The Collective shall continue for a perpetual period.
(a) Members whose capital interest as defined in Article 2.2 exceeds 50 percent vote for
dissolution; or
(b) Any event which makes it unlawful for the business of the Collective to be carried on
by the Members; or
(c) The death, resignation, expulsion, bankruptcy, retirement of a Member or the
occurrence of any other event that terminates the continued membership of a Member
of the Collective; or
(d) Any other event causing dissolution of this Limited Liability Company under the laws
of the Commonwealth of Massachusetts.
### 1.5 CONTINUANCE OF COMPANY.
Notwithstanding the provisions of ARTICLE 1.4, in the event of an occurrence described in ARTICLE 1.4(c), if there are at least two remaining Members, said remaining Members shall have the right to continue the business of the Collective. Such right can be exercised only by the unanimous vote of the remaining Members within ninety (90) days after the occurrence of an event described in ARTICLE 1.4(c). If not so exercised, the right of the Members to continue the business of the Collective shall expire.
### 1.6 BUSINESS PURPOSE.
The purpose of the Collective is to help people create and use tools and platforms that meet their needs. The Collective goal is the most power possible for all people over their own lives, and toward that goal the Collective takes on projects that connect ideas, resources, and people. The Collective uses and contributes to open source free software and ensure everything built free from restrictions, and the way it is built open, for clients to truly own.
### 1.7 PRINCIPAL PLACE OF BUSINESS.
The location of the principal place of business of the Collective shall be:
Boston, MA 02134
Principal place of business may be changed from time to time to a location the Managers select. Members may also use home-offices or any other workplace of their choice.
### 1.8 THE MEMBERS.
The name and place of residence of each Member is located at https://corp.sec.state.ma.us/CorpWeb/CorpSearch/CorpSummary.aspx?sysvalue=HjjIHbOP890XgjC6fWoReGpnXzMPqiTgvN_a5t8CxoA-
### 1.9 ADMISSION OF ADDITIONAL MEMBERS.
Except as otherwise expressly provided in the Agreement, no additional members may be admitted to the Collective through issuance by the Collective of a new interest in the Collective, without the prior unanimous written consent of the Members.
## ARTICLE II Capital Contributions
### 2.1 INITIAL CONTRIBUTIONS.
The Members initially shall contribute to the Company capital as described in Exhibit 3 attached to this Agreement. The agreed total value of such property and cash is $18,000.
### 2.2 ADDITIONAL CONTRIBUTIONS.
Except as provided in ARTICLE 6.2, no Member shall be obligated to make any additional contribution to the Company's capital.
## ARTICLE III Profits, Losses and Distributions
### 3.1 PROFITS/LOSSES.
For financial accounting and tax purposes the Company's net profits or net losses shall be determined on an annual basis and shall be allocated to the Members in proportion to each Member's relative capital interest in the Company as set forth in Exhibit 2 as amended from time to time in accordance with Treasury Regulation 1.704-1.
### 3.2 DISTRIBUTIONS.
The Members shall determine and distribute available funds annually or at more frequent intervals as they see fit. Available funds, as referred to herein, shall mean the net cash of the Company available after appropriate provision for expenses and liabilities, as determined by the Managers. Distributions in liquidation of the Company or in liquidation of a Member's interest shall be made in accordance with the positive capital account balances pursuant to Treasury Regulation 1.704-l(b)(2)(ii)(b)(2). To the extent a Member shall have a negative capital account balance, there shall be a qualified income offset, as set forth in Treasury Regulation 1.704-l(b)(2)(ii)(d).
### ARTICLE IV: Management
### 4.1 MANAGEMENT OF THE BUSINESS.
The name and place of residence of each Manager is located at https://corp.sec.state.ma.us/CorpWeb/CorpSearch/CorpSummary.aspx?sysvalue=HjjIHbOP890XgjC6fWoReGpnXzMPqiTgvN_a5t8CxoA-
Each Member is automatically a Manager. By a vote of the Members holding a majority of the capital interests in the Collective, as set forth in Schedule 2 as amended from time to time, shall elect so many additional non-Member Managers as the Members determine.
### 4.2 MEMBERS.
The liability of the Members shall be limited as provided pursuant to applicable law. No Member shall be an agent of any other Member of the Collective solely by reason of being a Member.
### 4.3 POWERS OF MANAGERS.
The Managers are authorized on the Collective's behalf to make all decisions as to
(a) the sale, development lease or other disposition of the Collective's assets;
(b) the purchase or other acquisition of other assets of all kinds;
(c) the management of all or any part of the Collective's assets;
(d) the borrowing of money and the granting of security interests in the Collective's assets;
(e) the pre-payment, refinancing or extension of any loan affecting the Company's assets;
(f) the compromise or release of any of the Collective's claims or debts; and,
(g) the employment of persons, firms or corporations for the operation and management of the company's business.
In the exercise of their management powers, the Collective are authorized to execute and deliver
(a) all contracts, conveyances, assignments leases, sub-leases, franchise agreements, licensing agreements, management contracts and maintenance contracts covering or affecting the Collective's assets;
(b) all checks, drafts and other orders for the payment of the Collective's funds;
(c) all promissory notes, loans, security agreements and other similar documents; and,
(d) all other instruments of any other kind relating to the Collective's affairs, whether like or unlike the foregoing.
### 4.4 NOMINEE.
Title to the Collective's assets shall be held in the Collective's name or in the name of any nominee that the Managers may designate. The Managers shall have power to enter into a nominee agreement with any such person, and such agreement may contain provisions indemnifying the nominee, except for his willful misconduct.
### 4.6 COMPANY INFORMATION.
Upon request, the Managers shall supply to any member information regarding the Collective or its activities. Each Member or his authorized representative shall have access to and may inspect and copy all books, records and materials in the Manager's possession regarding the Company or its activities. The exercise of the rights contained in this ARTICLE 4.6 shall be at the requesting Member's expense.
### 4.7 EXCULPATION.
Any act or omission of the Managers, the effect of which may cause or result in loss or damage to the Company or the Members if done in good faith to promote the best interests of the Company, shall not subject the Managers to any liability to the Members.
### 4.8 INDEMNIFICATION.
The Company shall indemnify any person who was or is a party defendant or is threatened to be made a party defendant, pending or completed action, suit or proceeding, whether civil, criminal, administrative, or investigative (other than an action by or in the right of the Company) by reason of the fact that he is or was a Member of the Company, Manager, employee or agent of the Company, or is or was serving at the request of the Company, for instant expenses (including attorney's fees), judgments, fines, and amounts paid in settlement actually and reasonably incurred in connection with such action, suit or proceeding if the Members determine that he acted in good faith and in a manner he reasonably believed to be in or not opposed to the best interest of the Company, and with respect to any criminal action proceeding, has no reasonable cause to believe his/her conduct was unlawful. The termination of any action, suit, or proceeding by judgment, order, settlement, conviction, or upon a plea of "no lo Contendere" or its equivalent, shall not in itself create a presumption that the person did or did not act in good faith and in a manner which he reasonably believed to be in the best interest of the Company, and, with respect to any criminal action or proceeding, had reasonable cause to believe that his/her conduct was lawful.
### 4.9 RECORDS.
The Managers shall cause the Company to keep at its principal place of business the following:
(a) a current list in alphabetical order of the full name and the last known street address
of each Member;
(b) a copy of the Certificate of Formation and the Company Operating Agreement and all
amendments;
(c) copies of the Company's federal, state and local income tax returns and reports, if
any, for the three most recent years;
(d) copies of any financial statements of the limited liability company for the three most
recent years.
## ARTICLE V: Compensation
### 5.1 MANAGEMENT FEE.
Any Manager rendering services to the Collective shall be entitled to compensation commensurate with the value of such services.
### 5.2 REIMBURSEMENT.
The Collective shall be able to establish policies for full or partial reimbursement to the Managers or Members for direct out-of-pocket expenses incurred by them in managing the Company.
## ARTICLE VI: Bookkeeping
### 6.1 BOOKS.
The Managers shall maintain complete and accurate books of account of the Collective's affairs at the Collective's principal place of business. Such books shall be kept on such method of accounting as the Managers shall select. The company's accounting period shall be the calendar year.
### 6.2 MEMBER'S ACCOUNTS.
The Managers shall maintain separate capital and distribution accounts for each member. Each member's capital account shall be determined and maintained in the manner set forth in Treasury Regulation 1.704-l(b)(2)(iv) and shall consist of his initial capital contribution increased by:
(a) any additional capital contribution made by him/her;
(b) credit balances transferred from her distribution account to her capital account;
and decreased by:
(c) distributions to him/her in reduction of Collective capital;
(d) the Member's share of Collective losses if charged to his/her capital account.
### 6.3 REPORTS.
The Managers shall close the books of account after the close of each calendar year, and shall prepare and send to each member a statement of such Member's distributive share of income and expense for income tax reporting purposes.
## ARTICLE VII: Transfers
### 7.1 ASSIGNMENT.
If at any time a Member proposes to sell, assign or otherwise dispose of all or any part of her interest in the Collective, such Member shall first make a written offer to sell such interest to the other Members at a price determined by mutual agreement. If such other Members decline or fail to elect such interest within thirty (30) days, and if the sale or assignment is made and the Members fail to approve this sale or assignment unanimously then, pursuant to the applicable law, the purchaser or assignee shall have no right to participate in the management of the business and affairs of the Collective. The purchaser or assignee shall only be entitled to receive the share of the profits or other compensation by way of income and the return of contributions to which that Member would otherwise be entitled.
## LISTING OF MEMBERS
An up-to-date list of Members of the Collective is located at:
https://corp.sec.state.ma.us/CorpWeb/CorpSearch/CorpSummary.aspx?sysvalue=HjjIHbOP890XgjC6fWoReGpnXzMPqiTgvN_a5t8CxoA-

134
roles.md
View file

@ -2,148 +2,28 @@
## Rotating cooperative-wide roles
In the interest of distributing types of work equitably and skill-sharing, a number of tasks ideally rotate— weekly, or monthly, or somewhat randomly.
In the interest of distributing types of work equitably and skill-sharing, a number of tasks rotate monthly or somewhat randomly.
### Meeting facilitator
### Standup facilitator
* Standup facilitator (all regular meetings)
* Monday/Friday planning facilitator (can be different than facilitator in standup part).
* Worker-owner meeting facilitator
### Monday planning facilitator
In practice standup facilitator has been Keegan 95% of the time, with Chris and Sanjay a bit more likely to pick up the planning facilitation.
### Friday shipping facilitator
### Worker-owner meeting facilitator
### Timecop
* Checks to ensure people get their time in each day by the end of Monday planning, mid-week daily standup, and Friday shipping. Works with people individually after the meeting to get the time in.
In practice, we have not done this for a while.
* Checks to ensure people get their time in each day by the end of Monday planning, mid-week daily standup, and Friday shipping. Works with people individually after the meeting to
### Scribe
* Write one sentence about each person's main activity in a week, summarizing our activities in an accessible way in blog posts such as "The Week That Was: Agaric's March 30th to April 3rd"
* As our main storyteller for the month, think about ways to weave the work we're doing every week into a narrative; if we can't fit our work into a narrative we're probably straying from our strategic goals.
Never put into practice and we really need to.
### Trainer/Educator
* Write informative blog posts
* Create curricula for trainings
* Submit speaking and training sessions
* Speak/training at events
* Help organize trainings, camps and conferences
Primary: Mauricio, Chris
Secondary: Keegan, Ben
### Infrastructure
* Create and support working development environment for each project
* Create and support staging site for each project
* Maintain deployment workflows for each project
Primary: Chris
Secondary: Louis, Ben
### Leads
* Cold calls (we have never done this)
* Future event scanner - list events of interest in advance
* Respond to requests received by contact form or email
* Write proposals
* Coordinate estimates
* Manage marketing-oriented pages on website
## Marketing
* Write blog posts
* Post to social media
* Coordinate sponsorship of events
* Network at events
* Take pictures and video
* Promote events we are part of
## Contractor Relations
* Communicate hours and progress with contractors
* Make sure contractors send invoice each month
* Make sure contractors get paid each month
* Check in on how contractors are feeling about their work and projects
* Check in with Agaric team on how things are going with contractors they work with
Currently making no effort to rotate.
Primary: Sanjay
Secondary: Micky
### Team Management
* Review planned time usage on a weekly basis (start of week, based on reports in Monday team tempo meeting)
* Make suggestions to try to ensure Agaric worker-owners combine for at least 60 billed hours a week (60x4x150=$36K/mo=clearing payroll).
* Works with project leads to find recommended tasks.
* Pairs with contractor relations for overall use of available Agaric time.
* Implement Team Tempo process
Unfilled since Clayton left.
## Project-specific roles
### Lead
#### Client Relations
* Hold monthly [sensing](https://gitlab.com/agaric/internal/wikis/meetings/sensing) and sprint planning/review meetings
* Send monthly ROS and project update
* Make sure payments from client are happening on time
* Update Agaric team on how a client is doing and how their projects are going in worker-owner meetings
This role as described has not really been filled since Clayton was here.
### Developer/Designer
#### Design
* Create wireframes/prototypes
* Create design mockups
* Create styleguide using HTML and SASS
Primary: Unfilled
#### Development
* Use contributed and custom modules to implement functionality
* Translate styleguide into working website
* Review others' code
* Test code
* Deploy approved changes
Primary: Ben, Mauricio, Louis
Secondary: Chris, Keegan
### User Research
* Define and measure project goals and key performance indicators (KPIs
* Define key user groups
* Conduct research to learn users' needs and motivations
### Project Manager
* Plan sprints
* Ensure issues have acceptance criteria and relevant info
* Facilitate project meetings
* Facilitate key milestones such as security updates, redesigns and launches
## Responding to Inadequate Performance of a Role's Duties
* Person noticing an issue address directly. If issue persists, call a meeting with the whole group to discuss a resolution/change.
## Suggestions for role-fluidity
* Define documentation requirements and tool usage for the role (e.g. effective use of GitLab for developers, detailed tracking in CMS tool)
* Specific email addresses for particular roles
* Document requirements of a role - hard skills, soft skills, and required resources (e.g. excellent communication, GnuCash familiarity, etc).
* "Pair-programming" approach
```{note}
Related: <a href="https://gitlab.com/agaric/internal/wikis/worker-owners">Worker Owners</a>
```

36
templates/drupal-module-project.md
View file

@ -1,36 +0,0 @@
# Drupal Module Project Page template
*This is what Drupal provides as a prompt for the description of a new module:*
```html
Here, write an introduction that summarizes the purpose and function of this project with a focus on users brand new to Drupal. Answer the question: What solution does this module provide? The first 200 characters of this will be shown when browsing projects. Alternatively, you can click “Edit summary” above and enter the exact summary you want (it should be 200 characters or less).
<h3 id="module-project--features">Features</h3>
Here, answer the following questions: What is the basic functionality? What unique features does enabling this project add? When and why would someone use this module? What use cases are there?
<h3 id="module-project--post-installation">Post-Installation</h3>
How does this module actually work once I install it? Should I go to a config page? Should I look for a new content type? Should I go and manage my text formats? Provide an overview of the configuration process and any other special considerations for the module.
<h3 id="module-project--additional-requirements">Additional Requirements</h3>
Does this project need anything beyond Drupal core? Include any dependent modules, libraries, APIs, etc., that are required for this project to work.
<h3 id="module-project--recommended-libraries">Recommended modules/libraries</h3>
Are there any projects that enhance or improve the functionality of this project?
<h3 id="module-project--similar-projects">Similar projects</h3>
If there are modules providing similar functionality, please describe what differentiates them.
<h3 id="module-project--support">Supporting this Module</h3>
If you have a Patreon, OpenCollective, etc. you can put links here to describe how people can support development.
<h3 id="module-project--community-documentation">Community Documentation</h3>
A great place to add links to YouTube walkthroughs, external documentation, or a demo site (use DrupalPod!).
You may continue to put additional information below here, if there are other things you think people need to know about your module!
```
*For financial support, a good default for our modules is:*
```html
You can support <a href="https://agaric.coop/">Agaric's</a> overall contributions to Drupal and a bit beyond <a href="https://opencollective.com/drutopia">by supporting Drutopia at opencollective.com/drutopia</a>. Thanks!!
```

15
tools/bookkeeping-with-gnucash.md
View file

@ -1,15 +0,0 @@
# Bookkeeping with GnuCash
## Initial setup
In **GnuCash Preferences** (reached via Edit » Preferences), select the **General** vertical tab (these are alphabetical), and under **Files**, uncheck "Compress files".
```{alert}
Turning off file compression is crucial because we commit our GnuCash file to Git for collaboration.
```
Also in **GnuCash Preferences**, select the **Register Defaults** vertical tab, and under **Default Style** at the top select "Auto-split ledger".
```{note}
This keeps the listing tight but allows quick recatogorization of expenses.
```

55
tools/creating-new-drutopia-site.md
View file

@ -5,11 +5,11 @@ Agaric manages a large number of Drupal, primarily [Drutopia](https://drutopia.o
Please see [the Drutopia Platform README for an overview of hosting and deploying Drutopia sites](https://gitlab.com/drutopia-platform/drutopia_host#introduction )
If you won't be deploying, skip overall setup.
Following this guide requires a working [DDEV](https://ddev.readthedocs.io/en/latest/) installation. Deploying to Drutopia will require a locally installed composer, as well as ansible. See also the [general Git setup](git-setup) if you have not yet.
Following this guide requires a working [DDEV](https://ddev.readthedocs.io/en/latest/) installation. See also the [general Git setup](git-setup) if you have not yet.
## Overall setup
In line as much as possible with [recommended locations](recommended-local-project-locations), the local setup can be done like this:
Strongly recommended to set up locally like this:
```
mkdir -p ~/Projects/drutopia-platform
@ -29,28 +29,31 @@ Commands for copying throughout will assume this above setup.
## Create a new site project
For Agaric clients, the online home for the project will usually be at [Agaric's Forgejo project hosting site](https://git.agaric.com), first creating an organization (such as `example-client`, the short name that Forgejo takes first must be treated as a machine name) and then the project (such as `example-org`) that would live a URL such as `https://git.agaric.com/example-client/example-org`.
Ordinarily this will live under https://gitlab.com/agaric/sites (for Agaric clients) or https://gitlab.com/drutopia-platform/sites (for direct Drutopia platform members).
Copy the part of the URL after `git.agaric.com` so the namespace will be consistent on your local machine and create the directory at `~/Projects`. With the examples above it would be `mkdir -p ~/Projects/example-client/example-org` and `cd ~/Projects/example-client/example-org`.
Copy the `composer.json`, `composer.lock`, and `.gitignore` files used by the appropriate build source, such as the [default build source for the Drutopia Platform](https://gitlab.com/drutopia-platform/build_source).
Once you have created and are in this directory, wherever you want your project to live within that namespace, you can copy-paste these commands for a quick start:
Replace "example" below with name of the site, usually derived from the main domain name, for instance `example-com`:
```
wget https://gitlab.com/drutopia-platform/build_source/-/raw/main/composer.json
wget https://gitlab.com/drutopia-platform/build_source/-/raw/main/composer.lock
wget https://gitlab.com/drutopia-platform/build_source/-/raw/main/.gitignore
MY_SITE="example"
mkdir -p ~/Projects/agaric/sites/$MY_SITE
cd ~/Projects/agaric/sites/$MY_SITE
```
Once you have created and are in this directory, whether `agaric/sites` or `drutopia-platform/sites` or wherever you want your project to live within the GitLab namespace, you can copy-paste these commands for a quick start:
```
wget https://gitlab.com/drutopia-platform/build_source/-/raw/master/composer.json
wget https://gitlab.com/drutopia-platform/build_source/-/raw/master/composer.lock
wget https://gitlab.com/drutopia-platform/build_source/-/raw/master/.gitignore
mkdir -p scripts
wget -O scripts/pull.sh https://gitlab.com/drutopia-platform/build_source/-/raw/main/scripts/pull.sh
wget -O scripts/retain-custom-htaccess.sh https://gitlab.com/drutopia-platform/build_source/-/raw/main/scripts/retain-custom-htaccess.sh
wget -O scripts/pull.sh https://gitlab.com/drutopia-platform/build_source/-/raw/master/scripts/pull.sh
chmod +x scripts/pull.sh
chmod +x scripts/retain-custom-htaccess.sh
ddev config --docroot=web --project-type=drupal10 --webserver-type=apache-fpm --database=mariadb:10.8 --php-version=8.1 --create-docroot
ddev config --docroot=web --project-type=drupal9 --composer-version=2 --webserver-type=apache-fpm --mariadb-version=10.5 --php-version=7.4 --create-docroot
ddev start
ddev auth ssh
ddev composer install
git init
git add .
git commit -m "Begin repository based on build_source main"
```
```{note}
@ -61,11 +64,7 @@ Webserver, PHP, and MySQL versions and types are selected here to match those us
In order to get a configuration that has the proper site key, it is easiest to first deploy the site to the eventual live location, and sync that database locally.
If you are creating a specialized build of Drutopia, you will have to add that to the host vars, and build that prior to deploying the site. `ahoy vars-edit` and `ahoy deploy-build <build_target>` are used for this.
```{note}
New builds should be added **only** as absolutely required. Configuration, and themes should be leveraged as much as possible prior to resorting to a new build. If additional modules are required, consider adding them to `build_source`, knowing they will be available for *all* Drutopia SaaS sites.
```
If you are creating a specialized build of Drutopia, you will have to add that to the host vars, and build that prior to deploying the site. `ahoy vars-edit` and `ahoy deploy-build <build_target>` are used for this. Note that new builds should be added ONLY as absolutely required. Configuration, and themes should be leveraged as much as possible prior to resorting to a new build. If additional/different modules are required, a new build is required - do *NOT* add them to `build_source` except when they are known to be required for *ALL* Drutopia basic sites.
Create a new site (member entry) per instructions in Drutopia hosting. The simplest method is to use `ahoy new-site <member-slug>` and follow its output to get started. Then use `ahoy deploy-site <member-instance>` to deploy one. Because the install using `drush site-install` that would be run when `drupal_install: true` is set in the site settings in Drutopia hosting, it is currently recommended to set this to false and use the UI installer or run `php docroot/core/scripts/drupal quick-start drutopia --no-interaction` when ssh'd into the server.
@ -73,7 +72,7 @@ Create a new site (member entry) per instructions in Drutopia hosting. The simpl
The [drush site aliases file](https://github.com/drush-ops/drush/blob/9.5.x/examples/example.site.yml) can be used to provide easy access to the live/test instances of a site. From the root of your project directory (e.g. `agaric/sites/example/`), you may create one with:
```bash
```
MY_SITE="example-com"
SERVER="drutopia.org"
mkdir -p drush/sites/
@ -95,30 +94,24 @@ test:
EOF
```
This will create a self.site.yml using the expected pattern of `site_name_INSTANCE` (e.g. `example_com_live` for the example-com live instance). Supply the URL form of the site name for the `MY_SITE` variable (i.e. with dashes, rather than underscores).
This will create a self.site.yml using the expected pattern of "site_name_INSTANCE" (e.g. example_com_live for the example-com live instance). Supply the URL form of the site name for the MY_SITE variable (i.e. with dashes, rather than underscores).
### Syncing, and setting up configuration
Our standard is to place configuration exports in `$project_root/config`. Set the this in `settings.php`:
Drutopia releases will expect the configuration in `$project_root/config/sync`. Be sure to set the appropriate variable in `settings.php` for it to be stored/retrieved from there. Note not to use `settings.ddev.php`, as this will be generated during `ddev start`:
```php
$settings['config_sync_directory'] = '../config';
$settings['config_sync_directory'] = '../config/sync';
```
While in `web/sites/default/settings.php` also prevent site administrators being told they can install new modules when they can't and add:
```php
$settings['allow_authorize_operations'] = FALSE;
$conf['allow_authorize_operations'] = FALSE;
```
This `settings.php` file is only being used for local development. Drutopia host is responsible for creating all settings during deployment.
(All this should be updated to use a distribution-wide settings.php when we have that. Until the, use `git add -f web/sites/default/settings.php` to include this in your repo)
```{note}
Do not to use `settings.ddev.php`, as this will be re-generated during `ddev start`.
```
Once you also have a working Drush installation and a live instance, you can then aquire and export the initial configuration with:
```

113
tools/deploying-drutopia-updates.md
View file

@ -2,19 +2,19 @@
## Prerequsites
Ensure you have at least PHP 7.2.5 installed. An 8.x version is recommended.
A bit more PHP than you need, but this will definitely get you ready for composer and friends:
```shell
sudo apt-get install ansible rsync php8.1-cli
```bash
sudo apt-get install ansible rsync php7.4 php7.4-gd php7.4-mysql php7.4-xml php7.4-curl php7.4-fpm php7.4-sqlite3 php7.4-cli
```
Then follow the commands from:
[getcomposer.org/download](https://getcomposer.org/download/)
Including the recommended:
And then:
```shell
```bash
sudo mv composer.phar /usr/local/bin/composer
```
@ -22,126 +22,45 @@ To make working with [Drutopia Platform's recommended Ansible setup](https://git
[github.com/ahoy-cli/ahoy](https://github.com/ahoy-cli/ahoy)
Get yourself added to the [Drutopia Platform project on GitLab](https://gitlab.com/groups/drutopia-platform/-/group_members) if you are not already, and [ensure your public SSH key is on Gitlab](https://gitlab.com/-/profile/keys).
Finally, [clone needed Drutopia repositories locally according to the recommended setup](creating-new-drutopia-site).
Finally, [clone needed Drutopia repositories locally according to the recommended setup](creating-new-drutopia-site#overall-setup).
Now you are ready for deploying Drutopia updates on a regular basis.
## Configure live to reach test instance
## Ensure you are up-to-date
**These instructions are no longer recommended. The Drutopia member role will set up the SSH connection along with the sync script (`sync_to_test.sh`).**
Log into the server on the live side, and check if you can reach the test side from there:
```shell
ssh {site}_live@drutopia.org # If using our ssh-config: d-{site}-live
ssh {site}_test@drutopia.org # d-{site}-test is not available here!
# If that command fails, create an ssh key:
ssh-keygen
cat ~/.ssh/id_rsa.pub
```
Copy the output of the cat command and disconnect (ctrl+d). Then add that public key to the authorized_hosts on the test side:
```shell
ssh {site}_test@drutopia.org
vi ~/.ssh/authorized_hosts
```
`shift+g` to get to the bottom, `o` to get into add mode on a new line, `ctrl+shift+p` (or appropriate) to paste the key, then `{esc}` to exit insert more, and `:wq` to write changes and quit.
Re-test reaching the server from the live side. This time you will have to accept the host key verification for drutopia.org which should be: `SHA256:MQXYY1PcuEgnIdyYawJSNZHbvLMwBXOx5CyDBvNSBmI.`
## Perform a sync to test
Log into the live version of the site and perform a sync of the db and files to the test instance:
```shell
ssh {site}-live@drutopia.org # If using our ssh-config: d-{site}-live
sync_to_test.sh
```
## Ensure you are up-to-date with all hosting repositories
```shell
```bash
cd ~/Projects/drutopia-platform/drutopia_host/hosting_private
ahoy git-pull-all
```
## Creating new site hosting entries
You can use ahoy to build a templated YAML snippet for yourself:
```shell
```
ahoy new-site example
```
Following the instructions this command provides to pull the newly created file into the vault.
And, following the instructions that provides, copy the
## Finding the site name and identify builds
```shell
## Determine the build to deploy
ahoy vault-view
# Without ahoy:
ansible-vault view host_vars/elizabeth.mayfirst.org/vault.yml
```
ansible-vault edit host_vars/elizabeth.mayfirst.org/vault.yml
```
Search for the site you are deploying. The `drutopia_version: ` key will identify the build to deploy in the next step.
## Prepare appropriate base
If using typical `sitename-test.drutopia.org` and `sitename-live.drutopia.org` domains pending the real site domain, add the subdomains to drutopia.org through the [May First control panel](https://members.mayfirst.org/cp/)
## Prepare the appropriate base build
Using ahoy, specify the name of the build to create as an argument to `ahoy deploy-build`:
```shell
```
ahoy deploy-build next
```
## Deploy your site
```shell
```
ahoy deploy-site example_test
```
And you can then share back the record of the deployments in the `build_artifacts` repository with:
```shell
ahoy artifacts
```
## Putting it all together
```shell
cd ~/Projects/drutopia-platform/drutopia_host/hosting_private
ahoy git-pull-all
ahoy deploy-build stable
ahoy deploy-site example_live
ahoy artifacts
```
## If you need to override site configuration:
```shell
ahoy deploy-site-force example_test
```
## Sync live database to test
If you have new content on the live site that you want to see how your code works with, or if you have created entities on the test site that block the removal of configuration you changed your mind about, you will want to sync from live to test.
```shell
ssh d-example-live
sync_to_test.sh
```
This handles making a paranoia dump of the test site in `~/backups`, dropping the test database to ensure no tables are left to clutter and interfere, skipping the content of cache tables, and bringing over user files (skipping cache files like the twig folder).
## Bonus: Keep Drutopia builds with similar available modules
To try to keep various Drutopia-based distributions from diverging too much, at least insofar as available modules, even if they aren't installed, we can use the **meld** (`sudo apt-get install meld`) diff tool to compare and share when posssible.
```shell
```bash
meld ~/Projects/agaric/sites/crla/crla-org/composer.json ~/Projects/agaric/sites/geo/composer.json ~/Projects/drutopia-platform/build_source/composer.json ~/Projects/agaric/sites/agaric-com/composer.json
```

16
tools/git-agaric-com-forgejo.md
View file

@ -1,16 +0,0 @@
# git.agaric.com's Forgejo
## User account creation and adding people to a project
As of now, do *not* invite users by e-mail address directly from a Team tab but instead:
1. Create user at https://git.agaric.com/admin/users/new
2. Return to the team tab for the organization (`org/example-organization/teams`
3. Click into ('View') the 'Owners' team `/org/example-organization/teams/owners` (or create) the team named after the client (so `/org/example-organization/teams/example`)
4. Use the search user bar to find that user account and then—only if it autocompletes and you select the user—the "Add Team Member" button.
*Side notes*
- Leave the setting for *User visibility* to *Private*.
- Leave *Allow Creation of Organizations by Default* disabled.
- (The 'Add Team Member' button used to be green, now it is red, why Forgejo why.)

2
tools/git-setup.md
View file

@ -38,7 +38,7 @@ Patterns which a user wants git to ignore in all situations (e.g., backup or tem
## Develop
Pick a ticket, create a branch referencing the ticket number, e.g. `git checkout -b project-123`. Commit your code in small chunks capturing logical steps and follow the [Drupal coding standards](https://drupal.org/coding-standards) and the [guidelines for commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). All configuration that accompanies your code, e.g. creating fields and content types, must be in the `config` directory or scripted in an update hook. Once your work is done request a review (merge request) for your code will get merged into the main branch.
Pick a ticket, create a branch referencing the ticket number, e.g. `git checkout -b project-123`. Commit your code in small chunks capturing logical steps and follow the [Drupal coding standards](https://drupal.org/coding-standards) and the [guidelines for commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). All configuration that accompanies your code, e.g. creating fields and content types, must be in the `config` directory or scripted in an update hook. Once your work is done request a review and eventually your code will get merged into the master branch.
Note: you may need to add your ssh key in the virtual machine. To do so with DDEV:

35
tools/git-usage.md
View file

@ -1,28 +1,8 @@
# Git usage
## Getting in sync with other developers
To bring in changes from other developers into the branch you are
working on, from main `git pull` and then `git checkout your-branch-name` and `git rebase main`
## Git troubleshooting
If you've accidentally made commits to main and cannot pull in other's changes as a result.
To get rid of a commit (the most recent one),
```
git reset HEAD^
```
to then be able to `git stash` changes from the commit, now local changes. To just throw everything in the commit away, `git reset --hard HEAD^`
See [sethrobertson.github.io/GitFixUm/fixup.html](https://sethrobertson.github.io/GitFixUm/fixup.html)
# Git Usage
## When NOT to manually resolve merge conflicts
When it is an automatically generated file!
When it's an automatically generated file!
For `composer.lock`, for example:
@ -32,14 +12,3 @@ ddev composer update
git add composer.lock
git commit
```
## Bringing feature branches into main
It is OK to do git merges rather than rebase on top of the main branch, especially when in the GitLab UI where merge is the only option— but be absolutely certain "Squash commits" is **not** checked.
### Discussion
Hmm git GUIs would show all the commits in the branch they were worked on when there are merge requests, right? (if not squashed?) Maybe better to prefer merges than rebases for feature branches, for preserving the history of where the work was done. My problem with git merge commits is they can rewrite history inside them, like have changes not shown in any other commit, and they make it hard to see what happened— does not show up in git log -p for instance. (You can see the history but if the stack overflow explanation does not fit on one page i don't want it as part of my daily workflow. https://stackoverflow.com/a/40986893/1028376 )

2
tools/setting-up-email.md
View file

@ -2,6 +2,6 @@
With the exception of the note below, follow the [May First documentation on how to configure Thunderbird](https://support.mayfirst.org/wiki/faq/email/setup-thunderbird) or [other e-mail clients](https://support.mayfirst.org/wiki/faq/email/pop-vs-imap).
For Server Name, Agaric team members use `mail.mayfirst.org` for incoming e-mail (POP or IMAP) and the May First standard, `mail.mayfirst.org` for outgoing (SMTP).
For Server Name, Agaric team members use `sojourner.mayfirst.org` for incoming e-mail (POP or IMAP) and the May First standard, `mail.mayfirst.org` for outgoing (SMTP).
For extra security, Agaric worker-owners are advised to set up a separate account for e-mail as for administrative duties within May First's control panel. A separate account could also be used for [Nextcloud](setting-up-nextcloud). This is probably unnecessary complexity for most clients. One account can be used for all services available through May First.

53
tools/setting-up-nextcloud.md
View file

@ -6,31 +6,18 @@ It is not possible to add accounts or change passwords in May First's Nextcloud
Log into [May First's control panel](https://members.mayfirst.org/cp/) with the organization's May First account and create a new User Account to use exclusively for Nextcloud, for instance `exampleorg-nextcloud`, with a strong password. It is not necessary to provide an e-mail address.
Also here at the **User Account** vertical tab, create user accounts for any people who will be using Nextcloud and do not already have May First accounts (either in the organization *or* anywhere else— May First accounts are universal across most tools provided by May First, including Nextcloud). Checkmark "Add a nextcloud item to this user account"
Be sure to set the disk space quota to something that would cover each person's expected use of Nextcloud (and e-mail, if that person will be using May First's e-mail also).
Now go to the **Nextcloud** vertical tab and adjust the quota allocated for their expected Nextcloud use, if more than 1GB. You can also add any of the user accounts for your organization to your Nextcloud for which you did not check the Nextcloud box when creating.
Also here, create user accounts for any people who will be using Nextcloud and do not already have May First accounts (either in the organization *or* anywhere else— May First accounts are universal across most tools provided by May First, including Nextcloud).
0. Log into [share.mayfirst.org](https://share.mayfirst.org/) with this new Nextcloud-only account.
1. Press the + sign under **Circles** to create a new circle under [Contacts](https://share.mayfirst.org/apps/contacts/All%20contacts)
2. Type a no-spaces version of the clients name (for instance, `exampleorg`) into the box for the name at the top center.
3. Under **Invites**, probably do not checkmark anything. Under **Visibility**, *do **not** select visible to everyone.
1. Go to [Circles](https://share.mayfirst.org/apps/circles/)
2. Type a no-spaces version of the clients name (for instance, `exampleorg`) into the "Create a new circle" box at the top left, under the Nextcloud logo.
3. For *Select a circle type* choose "Create a new personal circle".
Ask the people for whom you created accounts on May First to use the same username and password to sign into Nextcloud at [share.mayfirst.org](https://share.mayfirst.org/)
Ask the people with accounts on May First to use the same username and password to sign into Nextcloud at [share.mayfirst.org](https://share.mayfirst.org/)
Once they have confirmed they have done that, add each of those people to the circle (use the same username as they have in the user account in the May First control panel).
Add each of those people to the personal circle (use the same username as they have in the user account in the May First control panel, but they do need to sign into Nextcloud before you can add them).
```{admonition} You cannot share a folder or calendar with someone who has not yet logged in on share.mayfirst.org
Send an email to the client with instructions to log into NextCloud at https://share.mayfirst.org with their MayFirst username and password.
You can send a password reset email by using the "Password Reset" vertical tab in the left hand sidebar and
After a client has logged in to share.mayfirst.org, you will be able to share folders and files— and add them to the organization circle for access to anything you add it to.
```
Under [Files](https://share.mayfirst.org/apps/files/) on Nextcloud create a folder named after the organization (for instance `exampleorg`). Share that folder with the personal circle you previously created, by typing the circle name in the "Search for share recipients" box in the **Sharing** tab.
Under [Files](https://share.mayfirst.org/apps/files/) on Nextcloud create a folder named after the organization (for instance `exampleorg`). Share that folder with the personal circle you previously created.
Now every folder you create *within* that folder will be available to everyone in the organization (the people you added to the circle). And even if a person has multiple affiliations on May First's Nextcloud, the files related to the organization will be clearly namespaced.
@ -43,8 +30,28 @@ Now every folder you create *within* that folder will be available to everyone i
We create an organizaton account so that it's clear people are being invited to organization resources and there is no problem if an individual leaves an organization.
Because the account will have the same password for Nextcloud and for everything else in May First, we create an account through the May First control panel that will be used only for Nextcloud. This way credentials used, even rarely, for logging into Nextcloud are not also used to control web hosting, e-mail, and other critical resources.
Because the account will have the same password for Nextcloud and for everything else in May First, we create an account through the May First control panel that will be used only for Nextcloud. This way credentials used, even rarely, for logging into Nextcloud are not also used to control web hosting, e-mail, and other
## Original documentation to reconcile
When Agaric hosts a new client on MayFirst, the client gains access to the free software tools on the MayFirst platform.
Any user account in the MayFirst control panel can login to nextcloud with their MayFirst.org username and password.
NextCloud - https://share.mayfirst.org
Setup Client Access to NextCloud:
1. Login to NextCloud and create a client-nextcloud-admin user for the puprose of creating circles and organizing the nextcloud folders for the group.
2. Login to the Members Control Panel and create a user account for each person you will be sharing with.
2a. You can send them a password reset email (click "Password Reset") in the left hand side bar.
3. Create a secret circle in NextCloud using the circles icon on the toolbar
4. Send an email to the client with instructions to log into NextCloud at https://share.mayfirst.org with their MayFirst username and password.
5. After a client has logged in, you will be able to share folders and files.
Be sure everyone in the secret circle logs into NexCloud ​https://share.mayfirst.org/ so you can share folders with them.
You cannot share a folder or calendar with someone who has not yet logged in.
MayFirst suggestions for how groups can effectively use nextcloud to share. The steps are here: https://support.mayfirst.org/wiki/nextcloud#CanIcreategroupsofpeopletosharewith
Our steps are now largely in sync with May First's own recommendations; perhaps we can merge documentation.

2
tools/upgrading-drutopia-platform-elizabeth-sites.md
View file

@ -1,4 +1,4 @@
# Upgrading Drutopia sites on the Elizabeth Drutopia platform
1. Ensure BAT and BEE are not in use, and are uninstalled.
1. Ensure Markdown is not in use, and uninstalled.

7
tools/uptime-monitoring.md
View file

@ -1,7 +0,0 @@
# Uptime monitoring
We presently monitor that our sites and services are running correctly with [Uptime Kuma](https://uptime.kuma.pet/).
A public status report for Agaric sites is available here:
https://monitor.ocean.agaric.coop/status/agaric

33
wednesday-checkin.md
View file

@ -1,12 +1,14 @@
# Wednesday operations
# Wednesday Checkin
* No longer than half-an-hour, maximum.
The Monday checkin ensures everyone is on the same page starting the week. It is:
* No longer than one hour, maximum.
* Tasks should be [added to GitLab](https://gitlab.com/agaric/internal/-/boards/) as the meeting takes place.
Here is a template that can be pasted into a text pad (ideally markdown-aware).
```md
# 2024 Juluary 19th – Wednesday Checkin
# 2021 Juluary 19th – Wednesday Checkin
## Updates
@ -16,28 +18,6 @@ Here is a template that can be pasted into a text pad (ideally markdown-aware).
* Sanjay
* Ben
* Keegan
* Louis
## Invoice status
### Hours Entered (previous week)
* Ben -
* Chris -
* Keegan -
* Mauricio -
* Micky -
* Sanjay -
* Louis -
## Pair programming availability
* Ben
* Chris
* Keegan
* Mauricio
* Micky
* Sanjay
* Louis
## Blockers
@ -47,9 +27,6 @@ Here is a template that can be pasted into a text pad (ideally markdown-aware).
* Sanjay
* Ben
* Keegan
* Louis
## Availability
## Task allocation

8
weekly-rhythm.md
View file

@ -7,13 +7,13 @@ Agaric's weekly communication is structured like this:
* [Wednesday check-in](wednesday-checkin)
* [Friday review & planning](friday-review-and-planning)
One hour is the maximum time for any meeting.
We meet every day at 4 pm, except for Thursday which is meeting-free.
One hour is the maximum time for any meeting (including Friday review & planning and Monday checkin).
No (internal co-op-wide) meetings on Thursdays.
Check-in meetings are at 11:30am.
Tuesday worker-owner meetings are *as needed* at 1pm. The worker-owner meeting happens weekly with an agenda in advance. If there are no topics put forward to discuss by the day before it is skipped. There is no check-in (stand up) meeting on Tuesday.
The worker-owner meeting happens weekly with an agenda in advance. If there are no topics put forward to discuss it is skipped. There is no check-in (stand up) meeting on Tuesday.
```{toctree}
---

23
worker-owner-meeting.md
View file

@ -1,13 +1,9 @@
# Worker-Owner Meeting
# Worker Owner Meeting
Copy-pastable template:
The worker-owner meeting should mostly be populated with agenda items.
It replaces the daily standup if it falls on the same day as one, but ideally we would separate daily items to the daily/weekly rythm pad and leave the worker-owner notes with only the higher-level subjects. Switching pads during the meeting is too disruptive but maybe moving check-ins and work updates to the daily pad after the meeting would work.
```
# 2024 November 24
# 2020 November 24
## Check-ins (i.e. how are you, generally?)
@ -17,13 +13,22 @@ It replaces the daily standup if it falls on the same day as one, but ideally we
* Mauricio
* Micky
* Keegan
* Louis
## General Updates (work items)
* Ben
* Chris
* Sanjay
* Mauricio
* Micky
* Keegan
## Financial
Checking:
Savings:
Credit:
https://pad.drutopia.org/p/private_financial-transaction-of-note
### Payable
### Receivable
@ -31,7 +36,6 @@ Credit:
## Marketing
### Blog Posts
## Training
@ -39,11 +43,10 @@ Credit:
## Decisions to make
## Good News
* Ben
* Ben
* Chris
* Sanjay
* Mauricio
* Micky
* Keegan
* Louis
```

42
worker-owner.md Normal file
View file

@ -0,0 +1,42 @@
# Worker-Owner Meeting
The worker-owner meeting should mostly be populated with agenda items.
It replaces the daily standup, but ideally we would separate daily items to the daily/weekly rythm pad and leave the worker-owner notes with only the higher-level subjects. Switching pads during the meeting is too disruptive but maybe moving check-ins and work updates to the daily pad after the meeting would work.
```
# 2020 September 29
## Check-ins (i.e. how are you, generally?)
* Ben -
* Chris -
* David -
* Mauricio -
* Micky -
## General Updates (work items)
* Ben
* Chris
* David
* Mauricio overloaded, but managing to get word done.
* Micky
## Financial
Checking:
Savings:
Credit:
## Marketing
## Training
```