From 6197fa9f892feb2fa74159f1b3ee896004ffd68a Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Tue, 6 Feb 2024 22:59:53 +0100 Subject: [PATCH] Community docs (#446) --- docs/docs/community/_category_.json | 7 ++++ docs/docs/community/contributing.md | 40 ++++++++++++++++++++++ docs/docs/{ => community}/development.md | 8 ++--- docs/docs/running-bracket/quickstart.md | 3 +- docs/docusaurus.config.js | 43 +++++++++++++++++++++--- 5 files changed, 92 insertions(+), 9 deletions(-) create mode 100644 docs/docs/community/_category_.json create mode 100644 docs/docs/community/contributing.md rename docs/docs/{ => community}/development.md (91%) diff --git a/docs/docs/community/_category_.json b/docs/docs/community/_category_.json new file mode 100644 index 00000000..d672bab9 --- /dev/null +++ b/docs/docs/community/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Community", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docs/docs/community/contributing.md b/docs/docs/community/contributing.md new file mode 100644 index 00000000..7b2b4aa5 --- /dev/null +++ b/docs/docs/community/contributing.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 1 +--- + +# Contributing + +If you're using Bracket and would like to help support its development, that would be greatly +appreciated! + +Several areas that we need a bit of help with at the moment are: + +- ⭐ **Star Bracket** on GitHub +- 🌐 **Translating**: Help make Bracket available to non-native English speakers by adding your + language. See [Translating](#translating) below. +- 📣 **Spread the word** by sharing Bracket to help new users discover it +- 🖥️ **Submit a PR** to add a new feature, fix a bug, extend/update the docs or something else + +## Translating + +You can add a translation by copying the English `en` locale +([here](https://github.com/evroon/bracket/tree/master/frontend/public/locales)) directory. +Rename the directory to the name of your locale, and start translating the `common.json` file inside +the directory. It might be useful to use an online tool (Google `translate json file`) to do the +translation for you, and then carefully check and correct any mistakes. + +## Star History + + + +[![stargazers](https://img.shields.io/github/stars/evroon/bracket)](https://github.com/evroon/bracket/stargazers) + + + + + + Star History Chart + + + + diff --git a/docs/docs/development.md b/docs/docs/community/development.md similarity index 91% rename from docs/docs/development.md rename to docs/docs/community/development.md index 67796ce2..38c68bfa 100644 --- a/docs/docs/development.md +++ b/docs/docs/community/development.md @@ -1,12 +1,12 @@ --- -sidebar_position: 3 +sidebar_position: 2 --- -# Developing Bracket +# Developing This guide explains how to run Bracket without Docker. They cover database setup, configuration and how to run the frontend and backend. If you quickly want to get up and running, please read -[quickstart.md](running-bracket/quickstart.md). +[quickstart.md](../running-bracket/quickstart.md). ## Database @@ -31,7 +31,7 @@ You can do the same but replace the user and database name with: - `bracket_prod`: for a production database The database URL can be specified per environment in the `.env` files (see -[config](running-bracket/configuration.md)). +[config](../running-bracket/configuration.md)). ## Running the frontend and backend diff --git a/docs/docs/running-bracket/quickstart.md b/docs/docs/running-bracket/quickstart.md index 3f81ec8b..f80b948d 100644 --- a/docs/docs/running-bracket/quickstart.md +++ b/docs/docs/running-bracket/quickstart.md @@ -13,12 +13,13 @@ sudo docker-compose up -d ``` This will start the backend and frontend of Bracket, as well as a postgres instance. You should now -be able to view bracket at http://localhost:3000. You can log in with the following credentials: +be able to view bracket at `http://localhost:3000`. You can log in with the following credentials: - Username: `test@example.org` - Password: `aeGhoe1ahng2Aezai0Dei6Aih6dieHoo`. To insert dummy rows into the database, run: + ```bash sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db ``` diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 3469f7cd..5537e3a6 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -77,12 +77,17 @@ const config = { type: "docSidebar", sidebarId: "tutorialSidebar", position: "left", - label: "Docs", + label: "Documentation", + }, + { + label: "Quickstart", + href: "/docs/running-bracket/quickstart", + position: "left", }, { href: "https://github.com/evroon/bracket", label: "GitHub", - position: "right", + position: "left", }, ], }, @@ -95,16 +100,42 @@ const config = { style: "dark", links: [ { - title: "Docs", + title: "Intro", items: [ { label: "Introduction", to: "/docs/intro", }, + { + label: "Quickstart", + to: "/docs/running-bracket/quickstart", + }, + ], + }, + { + title: "Running Bracket", + items: [ { label: "Configuration", to: "/docs/running-bracket/configuration", }, + { + label: "Deployment", + to: "/docs/running-bracket/deployment", + }, + ], + }, + { + title: "Community", + items: [ + { + label: "Contributing", + to: "/docs/community/contributing", + }, + { + label: "Developing", + to: "/docs/community/development", + }, ], }, { @@ -114,6 +145,10 @@ const config = { label: "GitHub", href: "https://github.com/evroon/bracket", }, + { + label: "License", + href: "https://github.com/evroon/bracket/blob/master/LICENSE", + }, { label: "Changelog", href: "https://github.com/evroon/bracket/releases", @@ -121,7 +156,7 @@ const config = { ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} Bracket. Built with Docusaurus.`, + copyright: `Bracket - Self-Hosted Tournament System.
Licensed under AGPL-v3.0. Copyright © ${new Date().getFullYear()} Bracket. Built with Docusaurus.`, }, prism: { theme: lightCodeTheme,