mirror of
https://github.com/lukevella/rallly.git
synced 2025-04-28 09:46:39 +02:00
📝 Reorganize docs + add contributing guide (#687)
This commit is contained in:
Luke Vella
GitHub
parent
ebf78f5a84
commit
216532db30
21 changed files with 256 additions and 70 deletions
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
|
|
@ -3,5 +3,6 @@
|
|||
"source.fixAll": true
|
||||
},
|
||||
"typescript.tsdk": "node_modules/typescript/lib",
|
||||
"typescript.preferences.importModuleSpecifier": "non-relative"
|
||||
"typescript.preferences.importModuleSpecifier": "non-relative",
|
||||
"cSpell.words": ["Rallly", "Vella"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ In order to maintain a high standard of code quality, please ensure that you are
|
|||
|
||||
## Translations 🌐
|
||||
|
||||
To contribute translations, please check out our [guide for translators](https://support.rallly.co/become-a-translator) which contains all the information you need to get started.
|
||||
To contribute translations, please check out our [guide for translators](https://support.rallly.co/contribute/translations) which contains all the information you need to get started.
|
||||
|
||||
## Becoming a Sponsor 💰
|
||||
|
||||
|
|
@ -29,6 +29,10 @@ To become a sponsor, visit our [sponsor page](https://github.com/sponsors/lukeve
|
|||
|
||||
Donations are also accepted through [PayPal](http://paypal.me/ralllyco).
|
||||
|
||||
## Documentation
|
||||
|
||||
To contribute documentation please check out the [contributing guide](https://support.rallly.co/contribute/documentation) which contains all the information you need to get started.
|
||||
|
||||
## Code of Conduct 👮♀️
|
||||
|
||||
Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<img src="./docs/images/logo.png" alt="Rallly" />
|
||||
<img src="./assets/images/logo.png" alt="Rallly" />
|
||||
|
||||
<div align="center">
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Built with [Next.js](https://github.com/vercel/next.js/), [Prisma](https://githu
|
|||
|
||||
<div align="center">
|
||||
|
||||
<img src="./docs/images/poll-image.png" alt="Rallly" />
|
||||
<img src="./assets/images/poll-image.png" alt="Rallly" />
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ Please read our [contributing guide](CONTRIBUTING.md) to learn about how to cont
|
|||
|
||||
### Translators 🌐
|
||||
|
||||
You can help translate Rallly to another language by following our [guide for translators](https://support.rallly.co/become-a-translator).
|
||||
You can help translate Rallly to another language by following our [guide for translators](https://support.rallly.co/contribute/translations).
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
33
apps/docs/README.md
Normal file
33
apps/docs/README.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Support Docs
|
||||
|
||||
Live site: [https://support.rallly.co](https://support.rallly.co)
|
||||
|
||||
Our docs are written in [MDX](https://mdxjs.com/) which is mostly [Markdown](https://www.markdownguide.org/cheat-sheet) with the ability to use components inside.
|
||||
|
||||
This site is kindly built with and hosted by [Mintlify](https://mintlify.com).
|
||||
|
||||
## How to Run Locally
|
||||
|
||||
To preview your changes locally, you can use the [mintlify cli](https://mintlify.com/docs/development) to run a development server.
|
||||
|
||||
Install the cli globally:
|
||||
|
||||
```bash
|
||||
yarn global add mintlify
|
||||
```
|
||||
|
||||
Navigate to this directory (where you can find `mint.json`):
|
||||
|
||||
```bash
|
||||
cd apps/docs
|
||||
```
|
||||
|
||||
Start the development server:
|
||||
|
||||
```bash
|
||||
mintlify dev
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
Mintlify provides a number of useful built-in components such as [Accordion](https://mintlify.com/docs/components/accordion), [Tabs](https://mintlify.com/docs/components/tabs) and [Callouts](https://mintlify.com/docs/components/callouts). Check out their [documentation](https://mintlify.com/docs/components) to see the full list of components with examples.
|
||||
|
|
@ -27,7 +27,7 @@ After selecting your dates, you can also add a time range by switching on **Spec
|
|||
|
||||
<Accordion title="How do I manage timezones?">
|
||||
If you do choose to specify times, Rallly will automatically detect and set the timezone from your browser
|
||||
and participants will see times adjusted to their timezone when they vote. This behaviour is ideal for remote meetings where
|
||||
and participants will see times adjusted to their timezone when they vote. This behavior is ideal for remote meetings where
|
||||
participants can be in different timezones.
|
||||
|
||||
If the event is happening at a physical location, you can change the timezone to **Ignore timezone**
|
||||
|
|
|
|||
29
apps/docs/contact/support.mdx
Normal file
29
apps/docs/contact/support.mdx
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
title: Support
|
||||
description: Get in touch with us if you need help with anything
|
||||
---
|
||||
|
||||
If you have any questions, can reach out through the following
|
||||
channels:
|
||||
|
||||
<CardGroup cols={3}>
|
||||
<Card
|
||||
title="Email (recommended)"
|
||||
icon="envelope"
|
||||
iconType="duotone"
|
||||
href="mailto:support@rallly.co"
|
||||
>
|
||||
Send us an email
|
||||
</Card>
|
||||
<Card title="Discord" icon="discord" href="https://discord.gg/uzg4ZcHbuM">
|
||||
Join our Discord server
|
||||
</Card>
|
||||
<Card
|
||||
title="Support chat"
|
||||
iconType="duotone"
|
||||
icon="comments"
|
||||
href="https://go.crisp.chat/chat/embed/?website%5Fid=19d601db-af05-4f24-8342-8dd4449aedb8"
|
||||
>
|
||||
Chat with us
|
||||
</Card>
|
||||
</CardGroup>
|
||||
21
apps/docs/contribute/documentation.mdx
Normal file
21
apps/docs/contribute/documentation.mdx
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: Documentation
|
||||
icon: book
|
||||
description: Help us maintain and improve our documentation
|
||||
---
|
||||
|
||||
If you have a [Github](https://github.com) account, you can make changes or report issues using the links that appear at the top of each page.
|
||||
|
||||
<Frame caption="Links to edit a page or open an issue on Github">
|
||||
|
||||
</Frame>
|
||||
|
||||
## Submitting a Pull Request
|
||||
|
||||
Submitting a pull request is a great way to fix minor issues like typos or broken links.
|
||||
Click on the "pencil" icon and fork our repository to submit a pull request.
|
||||
|
||||
## Creating an Issue
|
||||
|
||||
For larger tasks, you can create a new issue by clicking on the "exclamation" icon.
|
||||
40
apps/docs/contribute/donations.mdx
Normal file
40
apps/docs/contribute/donations.mdx
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: Donations
|
||||
icon: coins
|
||||
description: Help fund this project and keep it ad-free
|
||||
---
|
||||
|
||||
## Why should I donate?
|
||||
|
||||
> Rallly is available free and without ads.
|
||||
> But free software doesn't mean it's without cost.
|
||||
> Someone has to develop, maintain, and support it.
|
||||
> With the help of generous people like you, we can keep Rallly ad-free for everyone and continue to make it even better.
|
||||
>
|
||||
> -- [Luke Vella](https://twitter.com/imlukevella), Creator of Rallly
|
||||
|
||||
## How can I donate?
|
||||
|
||||
You can donate using any of the following methods:
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
title="Donate with PayPal"
|
||||
icon="paypal"
|
||||
href="https://www.paypal.com/donate/?hosted_button_id=7QXP2CUBLY88E"
|
||||
></Card>
|
||||
<Card
|
||||
title="Sponsor on Github"
|
||||
icon="github"
|
||||
href="https://github.com/sponsors/lukevella"
|
||||
></Card>
|
||||
<Card
|
||||
title="Buy me a coffee"
|
||||
icon="cup-togo"
|
||||
href="https://www.buymeacoffee.com/lukevella"
|
||||
/>
|
||||
</CardGroup>
|
||||
|
||||
## What will my donation be used for?
|
||||
|
||||
Your donation will be used to cover the costs of running Rallly and to fund future development.
|
||||
40
apps/docs/contribute/introduction.mdx
Normal file
40
apps/docs/contribute/introduction.mdx
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: Introduction
|
||||
icon: hand-holding-heart
|
||||
description: Help us make Rallly better
|
||||
---
|
||||
|
||||
If you enjoy using Rallly and would like to contribute to its development, here are a few ways you can help out.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Donate" icon="coins" href="/contribute/donations">
|
||||
Help fund this project
|
||||
</Card>
|
||||
<Card title="Translate" icon="globe" href="/contribute/translations">
|
||||
Help translate Rallly into your language
|
||||
</Card>
|
||||
<Card
|
||||
title="Report a Bug"
|
||||
icon="bug"
|
||||
href="https://github.com/lukevella/rallly/issues/new?assignees=&labels=bug&template=---bug-report.md&title="
|
||||
>
|
||||
Help us find and fix bugs
|
||||
</Card>
|
||||
<Card title="Documentation" icon="book" href="/contribute/documentation">
|
||||
Help improve our documentation
|
||||
</Card>
|
||||
<Card
|
||||
title="Leave a review on Trustpilot"
|
||||
icon="star"
|
||||
href="https://www.trustpilot.com/review/rallly.co"
|
||||
>
|
||||
Help spread the word
|
||||
</Card>
|
||||
<Card
|
||||
title="Follow @ralllyco on Twitter"
|
||||
icon="twitter"
|
||||
href="https://twitter.com/ralllyco"
|
||||
>
|
||||
Help us grow our community
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: Become a Translator
|
||||
title: Translations
|
||||
icon: globe
|
||||
description: Help translate Rallly into your language
|
||||
---
|
||||
|
||||
|
|
@ -99,7 +100,7 @@ If your language requires more than one plural form, you can add additional rule
|
|||
|
||||
<Frame caption="Crowdin let's you preview your message to make sure it works">
|
||||
|
||||
Crowdin](/images/contribute/translations/icu-message-format.png)
|
||||
</Frame>
|
||||
|
||||
### Register
|
||||
BIN
apps/docs/images/contribute/documentation/edit-documentation.png
Normal file
BIN
apps/docs/images/contribute/documentation/edit-documentation.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
|
@ -1,44 +0,0 @@
|
|||
---
|
||||
title: "Support"
|
||||
description: "Welcome to the official documentation for Rallly."
|
||||
---
|
||||
|
||||
## What is Rallly?
|
||||
|
||||
Rallly is a tool for creating meeting polls. It's designed to help you
|
||||
schedule meetings with groups of people. It's free to use and
|
||||
you can create as many polls as you want.
|
||||
|
||||
## What is a Meeting Poll?
|
||||
|
||||
A meeting poll is a poll that helps you find a time that works for everyone. The host
|
||||
of the meeting will typically select a few date and time options for participants to choose
|
||||
from and then tally the results to find the best time.
|
||||
|
||||
## Guides
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Quick start" icon="note" href="/meeting-poll/creating-a-poll">
|
||||
Get started by learning how to create a new meeting poll.
|
||||
</Card>
|
||||
<Card title="Self-Hosting" icon="server" href="/self-hosting">
|
||||
Learn how to run your own instance of Rallly on your own server.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Contact
|
||||
|
||||
If your question isn't answered here you can reach out through the following
|
||||
channels:
|
||||
|
||||
<CardGroup cols={3}>
|
||||
|
||||
<Card title="Email" icon="envelope" href="mailto:support@rallly.co" />
|
||||
<Card title="Discord" icon="discord" href="https://discord.gg/uzg4ZcHbuM" />
|
||||
<Card
|
||||
title="Support chat"
|
||||
icon="comments"
|
||||
href="https://go.crisp.chat/chat/embed/?website%5Fid=19d601db-af05-4f24-8342-8dd4449aedb8"
|
||||
/>
|
||||
|
||||
</CardGroup>
|
||||
39
apps/docs/introduction.mdx
Normal file
39
apps/docs/introduction.mdx
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: "Introduction"
|
||||
description: "Welcome to the official documentation for Rallly."
|
||||
---
|
||||
|
||||
## What is Rallly?
|
||||
|
||||
Rallly is a tool for creating meeting polls. It's designed to help you
|
||||
schedule meetings with groups of people. It's free to use and
|
||||
you can create as many polls as you want.
|
||||
|
||||
> Rallly is pronounced like "rally" but with an extra _L_.
|
||||
>
|
||||
> I wanted to call the product "Rally" because that's what it's for - rallying people together to make things happen.
|
||||
> But, of course, the domain name was already taken. So, I did what any sane person would do - I added an extra _L_.
|
||||
>
|
||||
> -- [Luke Vella](https://twitter.com/imlukevella), Creator of Rallly
|
||||
|
||||
## What is a Meeting Poll?
|
||||
|
||||
A meeting poll is a poll that helps you find a time that works for everyone. The host
|
||||
of the meeting will typically select a few date and time options for participants to choose
|
||||
from and then tally the results to find the best time.
|
||||
|
||||
## Guides
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card title="Guides for Administrators" icon="user" href="/administrators">
|
||||
How to create a new meeting poll
|
||||
</Card>
|
||||
<Card title="Guides for Participants" icon="users" href="/contributing">
|
||||
How to respond to a meeting poll
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Contribute
|
||||
|
||||
This project is supported by the generosity of its users. Help us keep Rallly free and open-source by [donating](/contribute/donations) or check out
|
||||
our [contributing guide](/contribute) to learn how you can help.
|
||||
|
|
@ -6,9 +6,9 @@
|
|||
},
|
||||
"favicon": "/favicon.png",
|
||||
"colors": {
|
||||
"primary": "#4F46E5",
|
||||
"light": "#9C9EFF",
|
||||
"dark": "#6366F1",
|
||||
"primary": "#4f46e5",
|
||||
"light": "#6366f1",
|
||||
"dark": "#1f2937",
|
||||
"anchors": { "from": "#878AFA", "to": "#4347F1" }
|
||||
},
|
||||
"topbarCtaButton": {
|
||||
|
|
@ -23,22 +23,26 @@
|
|||
],
|
||||
"anchors": [
|
||||
{
|
||||
"name": "GitHub",
|
||||
"icon": "github",
|
||||
"url": "https://github.com/lukevella/rallly"
|
||||
"name": "Self-Hosting",
|
||||
"icon": "server",
|
||||
"url": "self-hosting"
|
||||
},
|
||||
{
|
||||
"name": "Blog",
|
||||
"icon": "newspaper",
|
||||
"url": "https://blog.rallly.co/"
|
||||
"name": "Contributing Guide",
|
||||
"icon": "hand-holding-heart",
|
||||
"url": "contribute"
|
||||
},
|
||||
{
|
||||
"name": "Contact us",
|
||||
"icon": "comments",
|
||||
"url": "https://go.crisp.chat/chat/embed/?website_id=19d601db-af05-4f24-8342-8dd4449aedb8"
|
||||
"name": "Contact",
|
||||
"icon": "messages",
|
||||
"url": "contact"
|
||||
}
|
||||
],
|
||||
"navigation": [
|
||||
{
|
||||
"group": "Documentation",
|
||||
"pages": ["introduction"]
|
||||
},
|
||||
{
|
||||
"group": "Guides for Administrators",
|
||||
"pages": [
|
||||
|
|
@ -64,8 +68,20 @@
|
|||
]
|
||||
},
|
||||
{
|
||||
"group": "Contribute",
|
||||
"pages": ["become-a-translator"]
|
||||
"group": "Contributing Guide",
|
||||
"pages": ["contribute/introduction"]
|
||||
},
|
||||
{
|
||||
"group": "How to Contribute",
|
||||
"pages": [
|
||||
"contribute/donations",
|
||||
"contribute/translations",
|
||||
"contribute/documentation"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Contact",
|
||||
"pages": ["contact/support"]
|
||||
}
|
||||
],
|
||||
"footerSocials": {
|
||||
|
|
|
|||
5
apps/docs/package.json
Normal file
5
apps/docs/package.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"name": "@rallly/docs",
|
||||
"version": "0.0.0",
|
||||
"private": true
|
||||
}
|
||||
|
|
@ -9,7 +9,7 @@ description:
|
|||
|
||||
</Frame>
|
||||
|
||||
If you see your response but it doesn't habe this badge, it means we can't tell
|
||||
If you see your response but it doesn't have this badge, it means we can't tell
|
||||
that you're the same person, either because you are using a different device or
|
||||
browser or because your cookies have been deleted. In this case you may need to
|
||||
contact the organizer of your poll to delete your response so that you can make
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ const Footer: React.FunctionComponent = () => {
|
|||
a: (
|
||||
<a
|
||||
className="font-normal leading-loose text-slate-500 underline hover:text-slate-800 hover:underline"
|
||||
href="https://www.paypal.com/donate/?hosted_button_id=7QXP2CUBLY88E"
|
||||
href="https://support.rallly.co/contribute/donations"
|
||||
/>
|
||||
),
|
||||
}}
|
||||
|
|
@ -149,7 +149,7 @@ const Footer: React.FunctionComponent = () => {
|
|||
}}
|
||||
/>
|
||||
<a
|
||||
href="https://support.rallly.co/become-a-translator"
|
||||
href="https://support.rallly.co/contribute/translations"
|
||||
className="hover:border-primary-600 hover:text-primary-600 inline-flex items-center rounded-md border px-3 py-2 text-xs text-slate-500"
|
||||
>
|
||||
<TranslateIcon className="mr-2 h-5 w-5" />
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 248 KiB After Width: | Height: | Size: 248 KiB |
|
|
@ -3,9 +3,10 @@
|
|||
"private": true,
|
||||
"version": "2.11.0",
|
||||
"scripts": {
|
||||
"dev": "dotenv -- turbo dev",
|
||||
"dev": "dotenv -- turbo dev --filter=@rallly/web...",
|
||||
"start": "turbo run start --filter=@rallly/web...",
|
||||
"build": "turbo run build --filter=@rallly/web...",
|
||||
"docs:dev": "turbo dev --filter=@rallly/docs...",
|
||||
"db:deploy": "prisma migrate deploy",
|
||||
"db:generate": "turbo db:generate",
|
||||
"db:migrate": "prisma migrate dev",
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue