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

Jump to bottom

Chapter Title Freeze for Rust Website #52

Closed
jamesmunns opened this issue Oct 16, 2018 · 11 comments
Closed

Chapter Title Freeze for Rust Website #52

jamesmunns opened this issue Oct 16, 2018 · 11 comments
Labels
T-resources

Comments

@jamesmunns
Copy link
Member

On the upcoming Rust website revision, we link to sections of the embedded book. We need to finalize/freeze these chapter names, so the links will be consistent (for now):
@jamesmunns
Copy link
Member Author

CC @rust-embedded/resources

@jamesmunns
Copy link
Member Author

I should note that the most important things to stabilize here are:

  • the filenames of the markdown file related to these chapters
  • any folder names above these markdown files that are reflected in the URL

@thejpster
Copy link
Contributor

Could I propose we don't put .html on the end of the canonical URLs? URLs are forever, file formats are for Christmas (or something).

@thejpster
Copy link
Contributor

Also, for consistency, maybe we should rename #8 to 'Concurrency'? (Or rename the directory to dynamic_data_structures?)

@adamgreig
Copy link
Member

Also, for consistency, maybe we should rename #8 to 'Concurrency'? (Or rename the directory to dynamic_data_structures?)

'Collections'?

@jamesmunns jamesmunns mentioned this issue Oct 29, 2018
Closed
@jamesmunns
Copy link
Member Author

jamesmunns commented Oct 30, 2018 •
edited
Loading

@thejpster I do not believe it is possible to omit the .html.

It is possible, I am full of lies.

For example:

  • https://rust-embedded.github.io/book/intro/no-std.html
  • https://rust-embedded.github.io/book/intro/no-std/
  • https://rust-embedded.github.io/book/intro/no-std
  • https://rust-embedded.github.io/book/intro/
  • https://rust-embedded.github.io/book/intro

@jamesmunns
Copy link
Member Author

@rust-embedded/resources

So I would propose the following:

  1. Rename Book section: Collections #8 to Collections, to match the current book contents and link
  2. use links in the format https://rust-embedded.github.io/book/intro/no-std for the website

This leaves one open question IMO:

Do we want to use the book link, or the bookshelf link? Concretely:

  • https://rust-embedded.github.io/bookshelf/book/intro/no-std OR
  • https://rust-embedded.github.io/book/intro/no-std

If we decide on this today, I will fix the links in the website, and I will add comments in the SUMMARY.md mentioning that the layout and links must not change without fixing upstream first (or having legacy redirects).

@jamesmunns jamesmunns mentioned this issue Oct 30, 2018
Closed
@thejpster
Copy link
Contributor

I vote https://rust-embedded.github.io/book/intro/no-std

@japaric
Copy link
Member

japaric commented Oct 30, 2018

Do we want to use the book link, or the bookshelf link?

At the end the rust-embedded.org link will be https://docs.rust-embedded.org/book/intro/no-std, right? So there won't be a bookshelf (or docs) in the path.

@japaric japaric mentioned this issue Nov 11, 2018
Merged
7 tasks
@jamesmunns
Copy link
Member Author

This can probably be closed, modulo two issues:

  • I need to PR the links to the website, which will be done shortly
  • Someone needs to write a top level intro to static guarantees

bors bot added a commit to rust-embedded/blog that referenced this issue Nov 14, 2018
@bors @japaric
Merge #25
27b3086 
25: This year in embedded Rust r=jamesmunns a=japaric

This is the blog post I mentioned during the last meeting. I'd like to publish
it next Wednesday.

All kind of feedback is welcomed! Let me know if there's something you'd like to
see mentioned in this post.

Blockers for publishing this:

- [x] docs.rust-embedded.org links should be up and running. This seems good to
  go for now but has been a bit flaky. We should keep an eye on it. cc
  @rust-embedded/infrastructure

- [x] book: remove empty chapters, chapter title freeze as per
  rust-embedded/book#52, move type state under static guarantees @jamesmunns

- [x] book/getting-started: add semihosting section. @japaric

- [x] book/getting-started: add registers section. @japaric / @thejpster -- see rust-embedded/book#76

- **[postponed]** book/getting-started: add ~device /~ interrupt section but this is blocked
  on svd2rust 0.14.0 so may not happen until after the blog post. @therealprof will work on this.

- [x] book/peripherals: merge the current getting-started/registers into this
  chapter. @jamesmunns / @thejpster -- see rust-embedded/book#76

- [x] rename new-book. @ryankurte

Additionally we might want to include these two in this post:

- **[postponed]** awesome-embedded-rust: "does this compile on stable?" community effort.

What: Make an issue with instructions (add version badge to each crate in the
list?) and link to it from the blog post.

I suggested this before. @rust-embedded/resources do you want to tackle this?

- [x] wg: 2019 wishlist

What: Make an issue collecting people thoughts on what should we focus on next
year: ecosystem gaps that need to be filled, docs that need to be written,
unstable stuff that should prioritized for stabilization, language feature
requests.

@rust-embedded/all thoughts? we'll probably have the "call for 2019 blog post"
soon, in any case. Should we run an informal survey ourselves, or just watch
over the incoming blog posts?

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
@japaric
Copy link
Member

japaric commented Nov 20, 2018

Someone needs to write a top level intro to static guarantees

Done in #92

@japaric japaric closed this as completed Nov 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-resources
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@adamgreig @thejpster @jamesmunns @japaric