Skip to content
Closed
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
18 changes: 18 additions & 0 deletions content/.env.default
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Default config for the open source checks in tools/checks
# Create a file named .env in the same directory to override these defaults
BASE_BRANCH='origin/main'
CHECK_HTTP_LINKS=true
CHECK_LOCALIZED_CONTENT=false
CHECK_MARKDOWN_LINT=true
CHECK_PROTECTED_FIELDS=true
CHECK_RELATIVE_LINKS=true
CHECK_RETEXT_ANALYSIS=true
CHECK_UNUSED_ASSETS=true
COMMIT_HASH=''
DEBUG=false
DELETE_UNUSED_ASSETS=false
FILES='changed'
ONLY_REQUIRED_CHECKS=false
POST_PULL_REQUEST_COMMENTS=false
PULL_REQUEST_NUMBER=0
REPOSITORY=''
16 changes: 16 additions & 0 deletions content/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
content/de-de/assets/** filter=lfs diff=lfs merge=lfs -text
content/en-us/assets/** filter=lfs diff=lfs merge=lfs -text
content/es-es/assets/** filter=lfs diff=lfs merge=lfs -text
content/fr-fr/assets/** filter=lfs diff=lfs merge=lfs -text
content/ja-jp/assets/** filter=lfs diff=lfs merge=lfs -text
content/ko-kr/assets/** filter=lfs diff=lfs merge=lfs -text
content/pt-br/assets/** filter=lfs diff=lfs merge=lfs -text
content/ru-ru/assets/** filter=lfs diff=lfs merge=lfs -text
content/zh-cn/assets/** filter=lfs diff=lfs merge=lfs -text
content/zh-tw/assets/** filter=lfs diff=lfs merge=lfs -text

# Git will always convert line endings to LF on checkout
* text eol=lf

# But treat tarballs as binary (no line ending conversion)
*.tgz binary
8 changes: 8 additions & 0 deletions content/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Folders
**/node_modules/
**output/
**dist/

# Files
.DS_Store
**.env
57 changes: 57 additions & 0 deletions content/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"MD001": true,
"MD003": {
"style": "atx"
},
"MD004": {
"style": "dash"
},
"MD005": true,
"MD007": true,
"MD009": true,
"MD010": false,
"MD011": false,
"MD012": true,
"MD013": false,
"MD014": true,
"MD018": true,
"MD019": true,
"MD020": true,
"MD021": true,
"MD023": true,
"MD024": false,
"MD025": true,
"MD026": true,
"MD027": true,
"MD028": true,
"MD029": true,
"MD030": false,
"MD031": true,
"MD032": true,
"MD033": false,
"MD034": true,
"MD035": {
"style": "---"
},
"MD036": false,
"MD037": false,
"MD038": true,
"MD039": true,
"MD040": true,
"MD042": true,
"MD045": false,
"MD046": false,
"MD047": true,
"MD048": {
"style": "backtick"
},
"MD049": {
"style": "underscore"
},
"MD050": {
"style": "asterisk"
},
"MD051": true,
"MD052": true,
"MD053": true
}
1 change: 1 addition & 0 deletions content/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry=https://registry.npmjs.org/
1 change: 1 addition & 0 deletions content/.nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v22.10.0
1 change: 1 addition & 0 deletions content/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/node_modules
14 changes: 14 additions & 0 deletions content/.prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"arrowParens": "always",
"bracketSameLine": true,
"bracketSpacing": true,
"endOfLine": "auto",
"jsxSingleQuote": true,
"printWidth": 80,
"proseWrap": "preserve",
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": false
}
8 changes: 8 additions & 0 deletions content/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
* @Roblox/creator-knowledge

/content/ @Roblox/documentation
/STYLE.md @Roblox/documentation
/content/en-us/education/ @Roblox/documentation @Roblox/education
/content/en-us/assets/education/ @Roblox/documentation @Roblox/education
/tools/checks/utils/allowedHttpLinks.txt @Roblox/creator-knowledge @Roblox/documentation @Roblox/education
/tools/checks/utils/do-not-machine-translate.txt @Roblox/creator-knowledge @Roblox/documentation @Roblox/education
82 changes: 82 additions & 0 deletions content/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement using GitHub's
**Report content** form. All complaints will be reviewed and investigated
promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
61 changes: 61 additions & 0 deletions content/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Contributing

This page provides more detailed instructions on the offline contribution process. Due to the size of this repository, we highly recommend using the online options outlined in [README.md](README.md).

## Setting up Git

The first step to contributing is to install Git. GitHub has thorough documentation for setting up [Git](https://docs.github.com/en/get-started/quickstart/set-up-git) and [Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage). On macOS, we recommend using [Homebrew](https://brew.sh/).

If you are new to Git, see [Git Guides](https://github.com/git-guides/) for explanations and tutorials. For a quick refresher on Git commands, see the [Git Cheat Sheet](https://education.github.com/git-cheat-sheet-education.pdf).

If you want to avoid the command line, a Git client like [GitHub Desktop](https://desktop.github.com) can perform all the operations on this page---cloning, branching, displaying diffs, and committing---but use whichever tool you prefer.

## Forking and Cloning

Instead of just cloning this repository, [fork it](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository) on GitHub. Then [clone your fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository):

```shell
git clone https://github.com/your-username/your-fork.git
```

For instructions on keeping your fork in sync with `Roblox/creator-docs` over time, see [Syncing a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).

## Creating a New Branch

After you clone your fork, create a new branch with a unique name. Creating branches keeps your work organized and discrete and helps avoid merge conflicts when you sync your fork with `Roblox/creator-docs`.

Because you eventually want to merge into the `main` branch, use it as the basis for your new branch.

1. First, navigate to the repository root:

```shell
cd creator-docs
```

1. Then switch to the `main` branch (if you're not already on it):

```shell
git checkout main
```

1. Finally, create your new branch:

```shell
git checkout -b your-new-branch
```

## Opening Pull Requests

When you're happy with your changes, commit them to your branch. Include a short summary and longer description:

```shell
git commit -m "summary" -m "description"
```

```shell
git push origin your-branch
```

Then open [`Roblox/creator-docs`](https://github.com/Roblox/creator-docs/pulls) on GitHub and click **New Pull Request**. Choose **main** as the _base_ branch and your branch as the _compare_ branch.

Add a title and description of your changes, confirm that the contribution is your own, original work that you have the right to submit, and create the pull request.
Loading