Rename book-example to guide (#1336)

`book-example` is a bit of a strange name given that it's not just an example.
rust-lang · Sep 23, 2020 · b77942d · b77942d
1 parent d0deee9
commit b77942d
Show file tree

Hide file tree

Showing 35 changed files with 12 additions and 12 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -31,12 +31,12 @@ jobs:
     - name: Install Rust (rustup)
       run: rustup update stable --no-self-update && rustup default stable
     - name: Build book
-      run: cargo run -- build book-example
+      run: cargo run -- build guide
     - name: Deploy to GitHub
       env:
         GITHUB_DEPLOY_KEY: ${{ secrets.GITHUB_DEPLOY_KEY }}
       run: |
-        touch book-example/book/.nojekyll
+        touch guide/book/.nojekyll
         curl -LsSf https://raw.githubusercontent.com/rust-lang/simpleinfra/master/setup-deploy-keys/src/deploy.rs | rustc - -o /tmp/deploy
-        cd book-example/book
+        cd guide/book
         /tmp/deploy
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,7 @@ target
 .DS_Store
 
 book-test
-book-example/book
+guide/book
 
 .vscode
 tests/dummy_book/book/

diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,7 @@ authors = [
 ]
 documentation = "http://rust-lang.github.io/mdBook/index.html"
 edition = "2018"
-exclude = ["/book-example/*"]
+exclude = ["/guide/*"]
 keywords = ["book", "gitbook", "rustbook", "markdown"]
 license = "MPL-2.0"
 readme = "README.md"

diff --git a/book-example/book.toml → guide/book.toml b/book-example/book.toml → guide/book.toml
diff --git a/book-example/src/404.md → guide/src/404.md b/book-example/src/404.md → guide/src/404.md
diff --git a/book-example/src/README.md → guide/src/README.md b/book-example/src/README.md → guide/src/README.md
diff --git a/book-example/src/SUMMARY.md → guide/src/SUMMARY.md b/book-example/src/SUMMARY.md → guide/src/SUMMARY.md
diff --git a/book-example/src/cli/README.md → guide/src/cli/README.md b/book-example/src/cli/README.md → guide/src/cli/README.md
diff --git a/book-example/src/cli/build.md → guide/src/cli/build.md b/book-example/src/cli/build.md → guide/src/cli/build.md
diff --git a/book-example/src/cli/clean.md → guide/src/cli/clean.md b/book-example/src/cli/clean.md → guide/src/cli/clean.md
diff --git a/book-example/src/cli/init.md → guide/src/cli/init.md b/book-example/src/cli/init.md → guide/src/cli/init.md
diff --git a/book-example/src/cli/serve.md → guide/src/cli/serve.md b/book-example/src/cli/serve.md → guide/src/cli/serve.md
diff --git a/book-example/src/cli/test.md → guide/src/cli/test.md b/book-example/src/cli/test.md → guide/src/cli/test.md
diff --git a/book-example/src/cli/watch.md → guide/src/cli/watch.md b/book-example/src/cli/watch.md → guide/src/cli/watch.md
diff --git a/book-example/src/continuous-integration.md → guide/src/continuous-integration.md b/book-example/src/continuous-integration.md → guide/src/continuous-integration.md
diff --git a/book-example/src/for_developers/README.md → guide/src/for_developers/README.md b/book-example/src/for_developers/README.md → guide/src/for_developers/README.md
diff --git a/book-example/src/for_developers/backends.md → guide/src/for_developers/backends.md b/book-example/src/for_developers/backends.md → guide/src/for_developers/backends.md
diff --git a/...or_developers/mdbook-wordcount/Cargo.toml → ...or_developers/mdbook-wordcount/Cargo.toml b/...or_developers/mdbook-wordcount/Cargo.toml → ...or_developers/mdbook-wordcount/Cargo.toml
diff --git a/...r_developers/mdbook-wordcount/src/main.rs → ...r_developers/mdbook-wordcount/src/main.rs b/...r_developers/mdbook-wordcount/src/main.rs → ...r_developers/mdbook-wordcount/src/main.rs
diff --git a/...ample/src/for_developers/preprocessors.md → guide/src/for_developers/preprocessors.md b/...ample/src/for_developers/preprocessors.md → guide/src/for_developers/preprocessors.md
diff --git a/book-example/src/format/README.md → guide/src/format/README.md b/book-example/src/format/README.md → guide/src/format/README.md
diff --git a/book-example/src/format/config.md → guide/src/format/config.md b/book-example/src/format/config.md → guide/src/format/config.md
diff --git a/book-example/src/format/example.rs → guide/src/format/example.rs b/book-example/src/format/example.rs → guide/src/format/example.rs
diff --git a/book-example/src/format/mathjax.md → guide/src/format/mathjax.md b/book-example/src/format/mathjax.md → guide/src/format/mathjax.md
diff --git a/book-example/src/format/mdbook.md → guide/src/format/mdbook.md b/book-example/src/format/mdbook.md → guide/src/format/mdbook.md
diff --git a/book-example/src/format/summary.md → guide/src/format/summary.md b/book-example/src/format/summary.md → guide/src/format/summary.md
diff --git a/book-example/src/format/theme/README.md → guide/src/format/theme/README.md b/book-example/src/format/theme/README.md → guide/src/format/theme/README.md
diff --git a/book-example/src/format/theme/editor.md → guide/src/format/theme/editor.md b/book-example/src/format/theme/editor.md → guide/src/format/theme/editor.md
diff --git a/book-example/src/format/theme/index-hbs.md → guide/src/format/theme/index-hbs.md b/book-example/src/format/theme/index-hbs.md → guide/src/format/theme/index-hbs.md
diff --git a/...e/src/format/theme/syntax-highlighting.md → ...e/src/format/theme/syntax-highlighting.md b/...e/src/format/theme/syntax-highlighting.md → ...e/src/format/theme/syntax-highlighting.md
diff --git a/book-example/src/misc/contributors.md → guide/src/misc/contributors.md b/book-example/src/misc/contributors.md → guide/src/misc/contributors.md
diff --git a/book-example/src/misc/introduction.md → guide/src/misc/introduction.md b/book-example/src/misc/introduction.md → guide/src/misc/introduction.md
diff --git a/src/preprocess/cmd.rs b/src/preprocess/cmd.rs
@@ -171,15 +171,15 @@ mod tests {
     use crate::MDBook;
     use std::path::Path;
 
-    fn book_example() -> MDBook {
-        let example = Path::new(env!("CARGO_MANIFEST_DIR")).join("book-example");
+    fn guide() -> MDBook {
+        let example = Path::new(env!("CARGO_MANIFEST_DIR")).join("guide");
         MDBook::load(example).unwrap()
     }
 
     #[test]
     fn round_trip_write_and_parse_input() {
         let cmd = CmdPreprocessor::new("test".to_string(), "test".to_string());
-        let md = book_example();
+        let md = guide();
         let ctx = PreprocessorContext::new(
             md.root.clone(),
             md.config.clone(),

diff --git a/tests/dummy_book/mod.rs b/tests/dummy_book/mod.rs
@@ -135,11 +135,11 @@ fn recursive_copy<A: AsRef<Path>, B: AsRef<Path>>(from: A, to: B) -> Result<()>
 }
 
 pub fn new_copy_of_example_book() -> Result<TempDir> {
-    let temp = TempFileBuilder::new().prefix("book-example").tempdir()?;
+    let temp = TempFileBuilder::new().prefix("guide").tempdir()?;
 
-    let book_example = Path::new(env!("CARGO_MANIFEST_DIR")).join("book-example");
+    let guide = Path::new(env!("CARGO_MANIFEST_DIR")).join("guide");
 
-    recursive_copy(book_example, temp.path())?;
+    recursive_copy(guide, temp.path())?;
 
     Ok(temp)
 }
diff --git a/tests/rendered_output.rs b/tests/rendered_output.rs
@@ -345,7 +345,7 @@ fn create_missing_file_with_config() {
 }
 
 /// This makes sure you can include a Rust file with `{{#playground example.rs}}`.
-/// Specification is in `book-example/src/format/rust.md`
+/// Specification is in `guide/src/format/rust.md`
 #[test]
 fn able_to_include_playground_files_in_chapters() {
     let temp = DummyBook::new().build().unwrap();