Skip to content

Commit

Permalink
Update repo README and some wiki contents
Browse files Browse the repository at this point in the history
  • Loading branch information
ajhalili2006 committed Jun 20, 2023
1 parent e89a95e commit c49a66f
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 14 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[![Netlify Status](https://api.netlify.com/api/v1/badges/1f39e366-a3d0-4aed-ab70-e0ce52f38f48/deploy-status)](https://app.netlify.com/sites/community-lores-main/deploys)

Community Lores is an collection of different documentations and wikis, combined in one place. This repo contains the project-wide documentation for Community Lores, hosted on Netlify and maintained with love by [The Pins Team](https://github.com/MadeByThePinsHub).
Community Lores is an collection of different documentations and wikis, combined in one place. This repo contains the project-wide documentation for Community Lores, hosted on Netlify and maintained with love by [Recap Time Squad](https://github.com/RecapTime).

## Contributing

Consult the CONTRIBUTING and [CODE_OF_CONDCT](/CODE_OF_CONDUCT.md) files before contributing. If you want to add your docs here, [read this page](https://community-lores.gq/contributors-guide/adding-to-database/).
Consult the CONTRIBUTING and [CODE_OF_CONDCT](/CODE_OF_CONDUCT.md) files before contributing. If you want to add your docs here, [read this page](https://lorebooks.eu.org/contribute/add-project/).

## Building the website

The webiste is built with [Mkdocs](https://mkdocs.org) with [the Material theme](https://squidfunk.github.io/mkdocs-material). You may need to have Python 3 and Node.js 12+ to build the website and create commits as per the Conventional Commits spec. See the contributing documentation in [`CONTRIBUTING.md`] file for details.
The webiste is built with [Mkdocs](https://mkdocs.org) with [the Material theme](https://squidfunk.github.io/mkdocs-material). You may need to have Python 3 and Node.js 12+ to build the website and create commits as per the Conventional Commits spec. See the contributing documentation in [`CONTRIBUTING.md`](CONTRIBUTING.md) file for details.
25 changes: 17 additions & 8 deletions docs/contribute/add-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,22 @@
# Adding an new project to Community Lores

Do you want to start an new documentation website under Community Lores (aka `lorebooks.wiki`)
banner? If so, you're welcome here to start a fresh project!
banner? If so, you're welcome here to start a fresh project (or transfer them into its new home)!

## Prerquisites

* **Your documentation website should be SFW.** Due to various reasons, we can't
accept NSFW documentation/wiki sites into our docs directory nor even hosted here.
* **Your content should be licensed under an free license for text and image-based content.** We're talking about [Creative Commons licenses][cc],
although most open-source licenses can be also used to website content too (using them at visuals are on the unchartered territory).
* **Your content should be licensed under an free license for text and image-based content.** We're talking about
[Creative Commons licenses][cc], although most open-source licenses can be also used to website content too
(using them at visuals are on the unchartered territory).
* **You should be abide by our [Code of Conduct](../../code-of-conduct.md) and [Website Hosting ToS](../../legal/tos.md).** Failure to do so might cause
your project to be ejected from the docs directory and even trigger an ban from our community if happened repeatedly.
* **For non-Recap Time Squad projects, your project or community might requires undergo verification and background checks.** [Visit the Verification Endpoint API documentation](https://rtapp-verify.lorebooks.eu.org) for
details on the process and how we do background checks.

[cc]: https://creativecommons.org/licenses

## Step-by-step process

This section contains both what steps requesters and squad members (and sometimes community wranglers) do during this process.
Expand Down Expand Up @@ -53,16 +56,22 @@ instead see https://go.lorebooks.eu.org/templates/subdomain-redirection.
Before hiting that `Create new issue` or `Submit` button, make sure the tittle of that ticket should follows the
following format below to help squad members and community wranglers to triage your request faster.

```
```plain
[new project request] Request for new project <repo-slug or project here>
```

[mau.dev-issues]: https://mau.dev/lorebooks.wiki/issue-tracker/issues/new
[srht-todo]: https://todo.sr.ht/~recaptime-dev/lorebooks.wiki
[srht-todo]: https://todo.sr.ht/~recaptime-dev/lorebooks.wiki
[^1]: Since we're migrating our repos to mau.dev because of free plan changes in SaaS version, gitlab.com project creation is currently limited until further notice.

### Squad Member/Community Wranglers: Review and triage the request

Once the request has been received, you should have an look first before assigning to yourself and adding the `new project requests:assigned` tag.
As an issue assignee, you're responsible for communicating between the infrastructure team (who have prvilleged access to project management and DNS stuff,
among other things) and the person who requested that new project creation and reviewing that request as if
Once the request has been received, you should have an look first before assigning to yourself and
adding the `new project requests:assigned` tag.
As an issue assignee, you're responsible for communicating between the Infra team (who have prvilleged access to
project management[^2] and DNS stuff, among other things) and the person who requested that new project creation and reviewing
it for possible issues.

[^2]: Although creating subgroups for your project/org under our root namespace requires additional scrutiny from
squad leaders and our legal team, ANY community members with `Maintainer` access can provision an project under
`lorebooks.wiki/docs-incubator` namespace.
18 changes: 18 additions & 0 deletions docs/directory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Wiki Directory

We index and keep track of different wikis

## Hosted on `lorebooks.wiki`

### Official Squad documentation sites

* [Squad Wiki](https://open.lorebooks.eu.org/squad)

### Maintained independently by squad members

* [Multiverse Wiki](https://open.lorebooks.eu.org/multiverse)

## Wikis by community/fandom

These wiki URLs are used behind the scenes for redirects at Multiverse Wiki to avoid duplication of content,
other than your regular dossiers made by squad members.
7 changes: 4 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
<!-- markdownlint-disable MD013 -->
# Welcome to the Community Lores!

**Community Lores**, also known as `loreboooks.wiki` in some places, is the documentation hub for documentation and wiki-related projects maintained
under some of Recap Time Squad's infrastructure
**Community Lores**, also known as `loreboooks.wiki` in some places, is the documentation hub for documentation and
wiki-related projects maintained with the infrastructure and assistance from Recap Time Squad. We treat this as our
documentation arm with its own

## Directory

Welcome to the project homepage!
Welcome to the project homepage! Here you can know more about

* [FAQs](faqs.md) - Have an question about this hub/department?
* [Contributors' Guide](contribute/index.md) - Contribute to documentations we host and maintain, learn how to maintain doc sites under our namespace, and more.
Expand Down

0 comments on commit c49a66f

Please sign in to comment.