Skip to content

Commit

Permalink
Merge pull request #589 from amelioro/docs-add-roles-to-fill
Browse files Browse the repository at this point in the history
Docs add roles to fill
  • Loading branch information
keyserj authored Dec 4, 2024
2 parents 62f8bed + 0063aa2 commit 5c7e158
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 5 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ All contributors (with GitHub accounts) will be recognized by being added to the

If you're new to open source, you'll probably find [this open source guide](https://opensource.guide/how-to-contribute) useful.

If you're interested in playing a specific role for the project, check out [Roles to Fill](https://ameliorate.app/docs/roles-to-fill).

## Code of Conduct

This project adheres to the Contributor Covenant [code of conduct](https://github.com/amelioro/ameliorate/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
Expand Down Expand Up @@ -46,7 +48,7 @@ Note: be particularly wary of [issues with a "needs [x]" label](https://github.c

### Non-code contributions

There are many ways to contribute without coding! [Providing feedback](#providing-feedback), building example diagrams, joining [discourse sessions](https://ameliorate.app/docs/discourse-sessions), sharing about the tool, creating/updating docs, etc. Check out the https://github.com/amelioro/ameliorate/labels/non-code issues for some specific tickets.
There are many ways to contribute without coding! [Providing feedback](#providing-feedback), building example diagrams, joining [discourse sessions](https://ameliorate.app/docs/discourse-sessions), sharing about the tool, creating/updating docs, etc. Check out the https://github.com/amelioro/ameliorate/labels/non-code issues for some specific tickets, and [Roles to Fill](https://ameliorate.app/docs/roles-to-fill) for specific roles you can help fill.

## Running the project

Expand Down
1 change: 1 addition & 0 deletions docs-site/pages/_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const meta = {
},
"discourse-sessions": "",
"release-status": "",
"roles-to-fill": "",
faq: "FAQ",
};

Expand Down
2 changes: 1 addition & 1 deletion docs-site/pages/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Ameliorate is currently being funded by its maintainer.

## Are there plans to look for funding for the project?

If the tool continues to be seen as useful, the plan is to look for funding towards the end of 2025, but funding will not go any routes that impede accessibility or UX. Maybe offering private hosting, consulting, or workshops. Grants?
Ideally there would be enough funding to help hire for the [Roles to Fill](/roles-to-fill), but minimally funding would enable at least the core maintainer to continue full-time on the project. If the tool continues to be seen as useful, the plan is to look for funding towards the end of 2025, but funding will not go any routes that impede accessibility or UX. Maybe offering private hosting, consulting, or workshops. Grants? Philanthropy?
2 changes: 1 addition & 1 deletion docs-site/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The documentation is split into an App section, which describes the tool itself
- 🎓 If you'd like to learn the basics of how to use the tool, a good place to start is [Getting Started](/getting-started).
- 🔮 If you'd like to get some background about motivation and goals for the tool, you can read the [Announcement Blog Post](https://medium.com/@keyser.joel/a-dream-to-ameliorate-547353f37945).
- ✨ If you'd like to stay up-to-date on progress of this ever-improving tool, subscribe to the [blog](https://amelioro.substack.com), [YouTube channel](https://www.youtube.com/@Ameliorate-xs5pl), follow the [Facebook page](https://www.facebook.com/profile.php?id=100091844721178), or see what's upcoming by checking out the [roadmap](https://github.com/orgs/amelioro/projects/2).
- 🌱 If you'd like to help make the tool better, feel free to chat in the [Discord server](https://discord.gg/3KhdyJkTWT), provide [feedback](https://github.com/amelioro/ameliorate/blob/main/CONTRIBUTING.md#providing-feedback), [contribute](https://github.com/amelioro/ameliorate/blob/main/CONTRIBUTING.md) to the code, or join a [Discourse Session](/discourse-sessions).
- 🌱 If you'd like to help make the tool better, feel free to chat in the [Discord server](https://discord.gg/3KhdyJkTWT), provide [feedback](https://github.com/amelioro/ameliorate/blob/main/CONTRIBUTING.md#providing-feedback), [contribute](https://github.com/amelioro/ameliorate/blob/main/CONTRIBUTING.md) to the code, or join a [Discourse Session](/discourse-sessions). You can also check out [Roles to Fill](/roles-to-fill).
51 changes: 51 additions & 0 deletions docs-site/pages/roles-to-fill.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Roles to Fill

Hi there! I'm Joel, the core maintainer of Ameliorate.

Currently, I'm "wearing many hats", trying to play a bunch of needed roles in order to make Ameliorate the best it can be. But I'm not great at all of these, and I'm definitely not great at doing them all at the same time. I think if others could help with these roles, Ameliorate would really thrive.

These could be filled by part-time volunteer efforts, but ideally funding would enable full-time roles. If you're interested in any of these roles, please [reach out](https://github.com/amelioro/ameliorate/blob/main/CONTRIBUTING.md#reaching-out) and you'll be considered if Ameliorate gets enough funding to hire.

Note: these are only what have come to mind as most-needed; there are many other ways to contribute that would still be helpful.

## "Co-founder"

- if there's only funding for one other role, it would have to be someone else that:
- is very passionate about the mission, vision, and how the tool is intended to accomplish those
- can help split all the desired roles below with me
- preferably has marketing/socializing/community-building skills

## UX designer

- make interface intuitive, sleek, and enjoyable
- these are critical for expanding usage/popularity/productiveness
- help landing page effectively convey the tool's value & vision, be inspiring

## Marketer/socializer/community-builder

- find people interested in the tool
- help convey value of the tool, inspire interest
- take people from "interested" to "using"/"getting value from" the tool
- foster a community around the tool, both for users and contributors
- probably host discourse sessions
- maybe make youtube videos, blog posts?
- potentially look for donors...? maybe separate role for that though? and probably should focus on community first

## Active user

- someone who actually just wants to use the tool all the time
- find opportunities to use the tool
- help refine the tool - not just its features, but its core concepts too
- perhaps there should be one of these roles to use the tool for community-style Topics, and one for small-group-style Topics

## Developer

- code quality from one person (i.e. myself) suffers tremendously without someone else to critique/review it
- there are way too many [features](https://github.com/orgs/amelioro/projects/2/views/1) to implement myself
- ideally I'd probably step back a little from development so I can aid the other roles/perform higher-level tasks

## Part time HR...?

- help hire people
- handle salaries/benefits
- manage nonprofit status?
1 change: 1 addition & 0 deletions docs-site/tailwind.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const config = {
extend: {},
},
plugins: [],
prefix: "_", // match nextra's tailwind prefix https://the-guild.dev/blog/nextra-3#tailwind-css-classes-prefixes-now-have-_-prefix-instead-of-nx--eslint-disable-line-
};

export default config;
8 changes: 6 additions & 2 deletions docs-site/theme.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,12 @@ const config = {
project: {
link: githubRepo,
},
// TODO: Make this identical to the logo in the main app (i.e. add "Alpha", and "Ameliorate")
logo: <Image src={faviconPng} height={32} width={32} alt="home" />,
logo: (
<div className="_flex _items-center _gap-2">
<Image src={faviconPng} alt="home" height={32} width={32} />
<span className="_text-xl _font-medium">Ameliorate</span>
</div>
),
logoLink: "https://ameliorate.app",
chat: {
link: discordInvite,
Expand Down

0 comments on commit 5c7e158

Please sign in to comment.