Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] main from staging #6

Merged
merged 3 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -242,4 +242,8 @@ dist
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# swap files
*.swp
*.save
### for Node.js - END ###
12 changes: 12 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"marquee.widgets.npm-stats.packageNames": [
"community-lores.github.io"
],
"githubPullRequests.ignoredPullRequestBranches": [
"staging"
],
"yaml.completion": true,
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs*.yml"
}
}
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.
2 changes: 1 addition & 1 deletion bin/rebuild-staging-config
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

rm mkdocs.dev.yml
cp mkdocs.yml mkdocs.dev.yml
find ./mkdocs.dev.yml -type f -exec sed -i 's/community-lores.gq/staging.community-lores.gq/g' {} \;
find ./mkdocs.dev.yml -type f -exec sed -i 's/lorebooks.eu.org/staging.lorebooks.eu.org/g' {} \;
2 changes: 2 additions & 0 deletions docs/_redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/tos/ /legal/tos/
/tos /legal/tos
77 changes: 77 additions & 0 deletions docs/contribute/add-project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<!-- markdownlint-disable MD013 -->
# 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 (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).
* **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.

### Requester: Submit an request for an new project

On the lorebooks.wiki's issue tracker in either [mau.dev][mau.dev-issues][^1] or [sr.ht][srht-todo], copy and paste this following
Markdown form template and fill up the necessary details.

```md
## Basic project information

* Project name:
* Desired repository slug:
* Is this SSG website or requires an server? Explain why or why not:

## Please describe the project in 120 characters or more.

<!-- Project description goes here. -->

## Where do you host the website?

<!--

Note that we only allow custom domains for projects that will be hosted under Community Lores banner/namespace.
If you want to park an subdomain for your wiki for redirection reasons, please DO NOT USE THIS template and
instead see https://go.lorebooks.eu.org/templates/subdomain-redirection.

-->

* Hosting service: Service Name, Type (Static|PaaS|VPS/delicated server behind the scenes)
* Subdomain (for backup purposes if going with custom domain): SUBDOMAIN.lorebooks.eu.org
* Custom domain: domain.tld (or N/A if going with the subdomain instead)
```

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
[^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 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.
11 changes: 11 additions & 0 deletions docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Contribute to the project
description:
---

Welcome to our contributors' guide!

## For maintainers

* [Setting up an new project](./add-project.md)
* [Transferring project maintainership](./transfer-maintainership.md)
63 changes: 0 additions & 63 deletions docs/contributors-guide/adding-to-database.md

This file was deleted.

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.
16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!-- markdownlint-disable MD013 -->
# Welcome to the Community Lores!

**Community Lores** is where different documentation and wikis are combined into one place, written in Markdown and without ads, tracking, and Google Analytics (We use our own instance of Ackee with detailed tracking enabled (OS, screen size, etc.), but no PII will be collected nor we're not interested in spying on you elsewhere. We only use these signals to better understand our traffic.)

## Directory

The full directory is still and will be under work in progress, so we'll update the list below as the docs expands.

* [FAQs](faqs)
* [Contributors' Guide](contributors-guide/index.md)
**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! 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.
* [Docs Directory](directory.md) - an publicly-maintained directory of documentation site projects we maintain and we know through other places
5 changes: 5 additions & 0 deletions docs/legal/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Legalese corner

* [Website hosting ToS](tos.md)
* [Privacy Policy](privacy-recaptimesquad.md)
* [Commenting system privacy policy](privacy-comments.md)
7 changes: 7 additions & 0 deletions docs/legal/tos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Website Hosting ToS

Effective: TBD / Last modified: TBD

!!! warning "Page is in draft state"
This legalese page is in progress of being written, and feedback and community input
is always welcome.
3 changes: 0 additions & 3 deletions docs/todo.md

This file was deleted.

94 changes: 0 additions & 94 deletions mkdocs.dev.yml

This file was deleted.

Loading