rust-embedded.github.io icon indicating copy to clipboard operation
rust-embedded.github.io copied to clipboard

Canonical domain for books

Open markhildreth opened this issue 5 years ago • 0 comments

For each book, there are a variety of URLs that can be used to access some version of the book. For example, the discovery book can be "found" under the following URLs:

  • https://docs.rust-embedded.org/discovery/
  • https://rust-embedded.github.io/discovery/

Since https://github.com/rust-embedded/wg/issues/208, the goal has been to host them all under docs.rust-embedded.org. However, there are inconsistencies, which in some cases cause poor SEO, in others can confusion and updated content to never reach users. I have tried to find these problems that are easy to fix and list them in one place, creating and/or linking to issues to any issues that should be resolved.

Discovery Book

Canonical URL: https://docs.rust-embedded.org/discovery/ Repo: https://github.com/rust-embedded/discovery

  • [ ] Canonical URL points to latest version found in repo (rust-embedded/wg/issues/457)
  • [ ] GitHub repo links to canonical URL (rust-embedded/discovery/issues/146)

Embedded Book

Canonical URL: https://docs.rust-embedded.org/book/ Repo: https://github.com/rust-embedded/book

  • [ ] Canonical URL points to latest version found in repo (rust-embedded/wg/issues/457)
  • [ ] GitHub repo links to canonical URL (https://github.com/rust-embedded/book/issues/93)

Embedonomicon

Canonical URL: https://docs.rust-embedded.org/embedonomicon/ Repo: https://github.com/rust-embedded/embedonomicon

  • [ ] Canonical URL points to latest version found in repo (rust-embedded/wg/issues/457)
  • [x] GitHub repo links to canonical URL

Additional Info

Currently, links using the correct domain might still use different paths, such as...

  • https://docs.rust-embedded.org/xxx
  • https://docs.rust-embedded.org/xxx/
  • https://docs.rust-embedded.org/xxx/index.html

I'm not too worried about these for now, but it might be nice to have a better canonical link system. See https://github.com/rust-lang/mdBook/issues/1238 for more.

markhildreth avatar May 29 '20 18:05 markhildreth