rust-lang / rust-lang/mdBook

Moving the web site to a subdomain of rust-lang.org

Open
#2,733 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

Right now the user documentation of mdbook is hosted on the github.io domain: https://rust-lang.github.io/mdBook/ I think it would be better to move it to be a subdomain of rust-lang.org, e.g. https://mdbook.rust-lang.org

Proposed Solution

In order to accomplish this one needs to configure the DNS and in the repository of the project set the subdomain (and click on enforce https).

The previous site will automatically redirect to the new one.

What do you think?

Notes

see also

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked GitHub Pages custom-domain instructions and the mdBook repository's Pages settings. Configure the DNS entry, set the custom domain to mdbook.rust-lang.org, enable HTTPS, and verify that the old GitHub Pages URL redirects to the new site.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, infrastructure
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.