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.

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

Canonical domain for books #23

Open
1 of 6 tasks
markhildreth opened this issue May 29, 2020 · 0 comments
Open
1 of 6 tasks

Canonical domain for books #23

markhildreth opened this issue May 29, 2020 · 0 comments

Comments

@markhildreth
Copy link

markhildreth commented May 29, 2020

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:

Since rust-embedded/wg#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

Embedded Book

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

Embedonomicon

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

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 rust-lang/mdBook#1238 for more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant