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

Prepare for teachbooks v0.2.0 #131

Open
wants to merge 22 commits into
base: release
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ parts:
- file: features/easy-editing.md
sections:
- file: external/template/README.md
- file: features/teachbooks
- file: features/draft-release
- file: external/deploy-book-workflow/README.md
- file: features/pull_request_build.md
- file: features/local_server
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(teachbooks-package)=
(draft-release)=
# Draft-Release Workflow

```{admonition} User types
Expand All @@ -8,7 +8,7 @@ This page is useful for user type 3-5.

{bdg-secondary}`Python Package: teachbooks`

Often it is necessary to prepare, review and edit materials in parallel to material that is currently being used by students, or another target audience. This workflow enables an author to easily maintain separate versions of a book without having to repeatedly comment out lines of a table of contents or page when building different versions. It is also easy to implement in CI/CD settings (it is already implemented in the {ref}Deploy Book Workflow <deploy-book-workflow>`, which builds our TeachBooks).
Often it is necessary to prepare, review and edit materials in parallel to material that is currently being used by students, or another target audience. This workflow enables an author to easily maintain separate versions of a book without having to repeatedly comment out lines of a table of contents or page when building different versions. It is also easy to implement in CI/CD settings (it is already implemented in the {ref}`Deploy Book Workflow <deploy-book-workflow>`, which builds our TeachBooks).

```{admonition} Why is this useful?
:class: tip
Expand Down
2 changes: 1 addition & 1 deletion book/features/external_toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When creating books, you might want to reuse material from other people or from
Previously, this book feature was implemented using [submodules](../external/Nested-Books/README.md), but the implementation was more difficult to use. Despite this, submodules are still a widely used Git feature that can be very useful for book authors, so check out the [submodules page](../external/Nested-Books/README.md) to learn more, especially if the External TOC tool does not satisfy your needs. Submodules have a few additional features not (yet) implemented using the External TOC.

```{warning}
The External TOC features are not incorporated in the new deploy book workflow yet (this will happen once the workflow specifies `teachbooks>=0.2.0`).
The External TOC features are incorporated in `v0.2.0` of the TeachBooks package. If you are using a TeachBooks Template book or our deploy-book-workflow this will become part of your book builds in GitHub Actions as the cache for your book expires (typically around 1 week after not editing your book branch). We do not expect it to cause issues with existing books, but if it does, you can use the following in your requirements file: `teachbooks<0.2.0`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have never warned people about updates and relevant caching in the past for the other tools (which are no different in this perspective).

Maybe this warning shouldn't be in the manual, but only in the announcement on teachbooks.io. Or we could remove the warning after a week. I think it can be kinda complicated for some users and giving the explicit explanation might do more harm than good on these very-easy-to-implement feature pages

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'We do not expect it to cause issues with existing books, but if it does, you can use the following in your requirements file: teachbooks<0.2.0.' If we really don't expect it, couldn't we just leave this out?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points, I'll adapt this and get back to you once I have a chance to read the stuff in #132

```

## What does it do?
Expand Down