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.

Sign up for GitHub

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

docs: document docs.rs #158

Merged
merged 1 commit into from
Oct 1, 2024
Merged

docs: document docs.rs #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions service-catalog/docs-rs/REAMDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Docs.rs

Docs.rs is a service that hosts documentation of crates.

The docs.rs codebase is available at [rust-lang/docs.rs] and
it's maintained by the [docs.rs team](https://www.rust-lang.org/governance/teams/dev-tools#team-docs-rs).

The codebase is deployed via the [terraform/docs-rs] module.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcoIeni to my knowledge this is not fully true.

Most of the deployment is done manually on the EC2 machine,

parts of the infra are managed by terraform (cloudfront, s3 for example),

but I think some things are just the "new" WIP infra, ( RDS / webserver), and not what we use in prod


The EC2 `docsrs.infra.rust-lang.org` is served by Cloudfront CDN at `docs.rs`.

Docs.rs also uses the `rust-docs-rs` S3 bucket which is served by Cloudfront CDN at `static.docs.rs`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the bucket is served through the docs.rs webserver itself, and additionally through static.docs.rs

( we are rewriting the doc pages before serving them)


[rust-lang/docs.rs]: https://github.com/rust-lang/docs.rs
[terraform/docs-rs]: https://github.com/rust-lang/simpleinfra/tree/master/terraform/docs-rs