Zeke Foppa
b9d30991f1
# Description of Changes Apparently, I missed several license files in #3002. I'm not sure what method I was using to find them, but apparently it was insufficient. **This replaces all empty `LICENSE` files with an explicit (symlink to) BSL license, and all apache licenses with symlinks to the root apache license.** This PR does not intentionally change any license terms, so if you see one that changed, **it's a mistake**. # API and ABI breaking changes None # Expected complexity level and risk 1 # Testing ```bash $ find . -name '*LICENSE*' -type f | grep -v '\.meta$' ./crates/sqltest/standards/LICENSE # this one is an external library that we are not allowed to re-license ./LICENSE.txt # this is the root license ``` --------- Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
Migration note
We are in the process of moving from the spacetimedb-docs repo to the docs subdirectory of SpacetimeDB. Any new changes should be made there. The spacetimedb-docs repo will only be updated on release. Apologies in advance for any sharp edges while the migration is in progress.
SpacetimeDB Documentation
This repository contains the markdown files which are used to display documentation on our website.
Making Edits
To make changes to our docs, you can open a pull request in this repository. You can typically edit the files directly using the GitHub web interface, but you can also clone our repository and make your edits locally. To do this you can follow these instructions:
- Fork our repository
- Clone your fork:
git clone ssh://git@github.com/<username>/SpacetimeDB
cd SpacetimeDB/docs
- Make your edits to the docs that you want to make + test them locally
- Commit your changes:
git add .
git commit -m "A specific description of the changes I made and why"
- Push your changes to your fork as a branch
git checkout -b a-branch-name-that-describes-my-change
git push -u origin a-branch-name-that-describes-my-change
- Go to our GitHub and open a PR that references your branch in your fork on your GitHub
NOTE! If you make a change to
nav.tsyou will have to runnpm run buildto generate a newdocs/nav.jsfile.
CLI Reference Section
- Run
cargo run --features markdown-docs -p spacetimedb-cli > cli-reference.md
We currently don't properly render markdown backticks and bolding that are inside of headers, so do these two manual replacements to make them look okay (these have only been tested on Linux):
sed -i'' -E 's!^(##) `(.*)`$!\1 \2!' docs/cli-reference.md
sed -i'' -E 's!^(######) \*\*(.*)\*\*$!\1 <b>\2</b>!' docs/cli-reference.md
Checking Links
We have a CI job which validates internal links. You can run it locally with npm run check-links. This will print any internal links (i.e. links to other docs pages) whose targets do not exist, including fragment links (i.e. #-ey links to anchors).
License
This documentation repository is licensed under Apache 2.0. See LICENSE.txt for more details.