Skip to content

Commit acceaef

Browse files
committed
add blacklisting crates to the docs.rs docs
1 parent d21533f commit acceaef

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/infra/docs/docs-rs.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,21 @@ cratesfyi database delete-crate CRATE_NAME
9393
The command will remove all the data from the database, and then remove the
9494
files from S3.
9595

96+
### Blacklisting crates
97+
98+
Occasionally it might be needed to prevent a crate from being built on docs.rs,
99+
for example if we can't legally host the content of those crates. To add a
100+
crate to the blacklist, preventing new builds for it, you can run:
101+
102+
```
103+
cratesfyi database blacklist add <CRATE_NAME>
104+
```
105+
106+
Other operations (such as `list` and `remove`) are also supported.
107+
108+
> **Warning:** blacklisting a crate doesn't remove existing content from the
109+
> website, it just prevents new versions from being built!
110+
96111
[repo]: https://github.com/rust-lang/docs.rs
97112
[grafana-instance]: https://grafana.rust-lang.org/d/rpXrFfKWz/instance-metrics?orgId=1&var-instance=docsrs.infra.rust-lang.org:9100
98113
[grafana-app]: https://grafana.rust-lang.org/d/-wWFg2cZz/docs-rs?orgId=1

0 commit comments

Comments
 (0)