language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 02:39:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Move documentation to docs.astral.sh/ruff (#7419)

Browse source 
## Summary

We're planning to move the documentation from
[https://beta.ruff.rs/docs](https://beta.ruff.rs/docs) to
[https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), for a few
reasons:

1. We want to remove the `beta` from the domain, as Ruff is no longer
considered beta software.
2. We want to migrate to a structure that could accommodate multiple
future tools living under one domain.

The docs are actually already live at
[https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), but later
today, I'll add a permanent redirect from the previous to the new
domain. **All existing links will continue to work, now and in
perpetuity.**

This PR contains the code changes necessary for the updated
documentation. As part of this effort, I moved the playground and
documentation from my personal Cloudflare account to our team Cloudflare
account (hence the new `--project-name` references). After merging, I'll
also update the secrets on this repo.
This commit is contained in:
Charlie Marsh 2023-09-15 22:49:42 -04:00 • committed by GitHub
parent cc9e84c144
commit 9b43162cc4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 58 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

22
scripts/generate_mkdocs.py
View file

@ -35,20 +35,20 @@ SECTIONS: list[Section] = [
LINK_REWRITES: dict[str, str] = {
"https://beta.ruff.rs/docs/": "index.md",
"https://beta.ruff.rs/docs/configuration/": "configuration.md",
"https://beta.ruff.rs/docs/configuration/#pyprojecttoml-discovery": (
"https://docs.astral.sh/ruff/": "index.md",
"https://docs.astral.sh/ruff/configuration/": "configuration.md",
"https://docs.astral.sh/ruff/configuration/#pyprojecttoml-discovery": (
"configuration.md#pyprojecttoml-discovery"
),
"https://beta.ruff.rs/docs/contributing/": "contributing.md",
"https://beta.ruff.rs/docs/editor-integrations/": "editor-integrations.md",
"https://beta.ruff.rs/docs/faq/#how-does-ruff-compare-to-flake8": (
"https://docs.astral.sh/ruff/contributing/": "contributing.md",
"https://docs.astral.sh/ruff/editor-integrations/": "editor-integrations.md",
"https://docs.astral.sh/ruff/faq/#how-does-ruff-compare-to-flake8": (
"faq.md#how-does-ruff-compare-to-flake8"
),
"https://beta.ruff.rs/docs/installation/": "installation.md",
"https://beta.ruff.rs/docs/rules/": "rules.md",
"https://beta.ruff.rs/docs/rules/#error-e": "rules.md#error-e",
"https://beta.ruff.rs/docs/settings/": "settings.md",
"https://docs.astral.sh/ruff/installation/": "installation.md",
"https://docs.astral.sh/ruff/rules/": "rules.md",
"https://docs.astral.sh/ruff/rules/#error-e": "rules.md#error-e",
"https://docs.astral.sh/ruff/settings/": "settings.md",
}
@ -94,7 +94,7 @@ def main() -> None:
raise ValueError(msg)
content = after
if m := re.search(r"\(https://beta.ruff.rs/docs/.*\)", content):
if m := re.search(r"\(https://docs.astral.sh/ruff/.*\)", content):
msg = f"Unexpected absolute link to documentation: {m.group(0)}"
raise ValueError(msg)