simplified template, renamed book_slug to repository_name

CONTRIBUTING.md

@@ -10,7 +10,7 @@ You can contribute in many ways:
 
 ### Report Bugs, Request Features or Submit Feedback
 
-Report bugs as a [GitHub issue](https://github.com/executablebooks/cookiecutter-jupyter-book/issues).
+Report bugs as a [GitHub issue](https://github.com/scads/jupyter-book-template/issues).
 
 If you are reporting a bug, please include:
 
@@ -27,17 +27,17 @@ If you are proposing a feature, please include:
 
 ### Improvements
 
-Look through the (https://github.com/executablebooks/cookiecutter-jupyter-book/issues) for bugs, feature requests, etc and feel free to contribute!
+Look through the (https://github.com/scads/jupyter-book-template/issues) for bugs, feature requests, etc and feel free to contribute!
 
 ## Get Started
 
-Ready to contribute? Here's how to set up `cookiecutter-jupyter-book` for local development.
+Ready to contribute? Here's how to set up `jupyter-book-template` for local development.
 
-1. Fork the `cookiecutter-jupyter-book` repo on GitHub.
+1. Fork the `scads/jupyter-book-template` repo on GitHub.
 2. Clone your fork locally and install requirements:
 
 ```sh
-git clone git@github.com:your_name_here/cookiecutter-jupyter-book.git
+git clone https://github.com/your_name_here/jupyter-book-template
 pip install -r requirements.txt
 ```
 
@@ -57,4 +57,4 @@ git commit -m "Your detailed description of your changes."
 git push origin name-of-your-bugfix-or-feature
 ```
 
-5. Open a pull request through the GitHub website. Naming convention for pull requests is [detailed here](https://github.com/executablebooks/.github/blob/main/CONTRIBUTING.md#commit-messages). For example, a pull request that adds a new feature might be titled: `✨ NEW: validate entered github username`.
+5. Open a pull request through the GitHub website. Naming convention for pull requests is [detailed here](https://github.com/scads/jupyter-book-template/blob/main/CONTRIBUTING.md#commit-messages).

README.md

@@ -34,8 +34,8 @@ cookiecutter https://github.com/scads/jupyter-book-template
   [1/9] author_name (Scala Ble, Dataan Lytics and AI): Robert Haase
   [2/9] github_username (roberthaase): haesleinhuepf
   [3/9] email ([email protected]): [email protected]
-  [4/9] book_name (My Book): first-book
-  [5/9] book_slug (first_book):
+  [4/9] book_name (My Book): First book
+  [5/9] repository_name (first_book):
   [6/9] book_short_description (Just another ScaDS.AI Jupyter Book about ...):
   [7/9] version ('0.1.0'):
   [8/9] open_source_license (CC BY 4.0):

cookiecutter.json

@@ -3,7 +3,7 @@
   "github_username": "scads",
   "email": "[email protected]",
   "book_name": "My Book",
-  "book_slug": "{{ cookiecutter.book_name.lower().replace(' ', '_').replace('-', '_') }}",
+  "repository_name": "{{ cookiecutter.book_name.lower().replace(' ', '_').replace('-', '_') }}",
   "book_short_description": "Just another ScaDS.AI Jupyter Book about ...",
   "version": "'0.1.0'",
   "open_source_license": "CC BY 4.0",

{{cookiecutter.book_slug}}/.gitlab-ci.yml

@@ -24,8 +24,8 @@ before_script:
 pages:
   script:
     - pip install -r requirements.txt
-    - jupyter-book build {{ cookiecutter.book_slug }}
-    - mv {{ cookiecutter.book_slug }}/_build/html/ public/
+    - jupyter-book build .
+    - mv /_build/html/ public/
   artifacts:
     paths:
       - public

{{cookiecutter.book_slug}}/README.md

@@ -4,7 +4,7 @@
 
 You can read its content at
 
-https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.book_name }}
+https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.repository_name }}
 
 ## Usage
 
@@ -14,11 +14,11 @@ If you'd like to develop and/or build the {{ cookiecutter.book_name }} book, you
 
 1. Clone this repository
 2. Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
-3. (Optional) Edit the books source files located in the `{{ cookiecutter.book_slug }}/` directory
-4. Run `jupyter-book clean {{ cookiecutter.book_slug }}/` to remove any existing builds
-5. Run `jupyter-book build {{ cookiecutter.book_slug }}/`
+3. (Optional) Edit the books source files.
+4. Run `jupyter-book clean .` to remove any existing builds
+5. Run `jupyter-book build .`
 
-A fully-rendered HTML version of the book will be built in `{{ cookiecutter.book_slug }}/_build/html/`.
+A fully-rendered HTML version of the book will be built in `/_build/html/`. Make sure to never upload this folder to github.
 
 ### Hosting the book
 
@@ -28,7 +28,7 @@ For GitHub and GitLab deployment specifically, the [cookiecutter-jupyter-book](h
 
 ## Contributors
 
-We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.book_slug }}/graphs/contributors).
+We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repository_name }}/graphs/contributors).
 
 ## Credits
 

{{cookiecutter.book_slug}}/_config.yml

@@ -17,7 +17,7 @@ execute:
 
 # Information about where the book exists on the web
 repository:
-  url: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.book_name }}  # Online location of your book
+  url: https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repository_name }}  # Online location of your book
   path_to_book: docs  # Optional path to your book, relative to the repository root
   branch: main  # Which branch of the repository should be used when creating links (optional)