-
Notifications
You must be signed in to change notification settings - Fork 6
TeachBooks Package Update #44
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
Merged
Tom-van-Woudenberg
merged 8 commits into
release
from
19-update-teachbooks-page-in-manual-replace-readme-submodule
Dec 11, 2024
Merged
TeachBooks Package Update #44
Tom-van-Woudenberg
merged 8 commits into
release
from
19-update-teachbooks-page-in-manual-replace-readme-submodule
Dec 11, 2024
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
rlanzafame
commented
Dec 11, 2024
- changed from external/readme to internal features/teachbooks.md https://teachbooks.io/manual/19-update-teachbooks-page-in-manual-replace-readme-submodule/features/teachbooks.html
- added page explaining need and examples of local servers (of which teachbooks serve is 1) https://teachbooks.io/manual/19-update-teachbooks-page-in-manual-replace-readme-submodule/features/local_server.html
- pointed out with user type box on top of page that the info is relevant for all (most??), but implemention not all user types
- updated external/deploy-book-workflow with a ref tag and updated commit (i think!)
Tom-van-Woudenberg
requested changes
Dec 11, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I deleted the submodule
- deploy-book-workflow seems fine!
- I've made the title more descriptive
- Fixed typo
I like the idea to split the teachbook functionaliteit to different features in the manual. I think for the typical manual-reader, it's not clear what But maybe we should do that properly:
- Add a separate page for draft-release workflow (although that workflow is a bit outdated with many branches and proper use of one branch per 'feature')
- Move teachbook local serve to the local_serve page fully.
- Keep the teachbooks page only with a description of the package itself and the 'Jupyter Book Pre- and Post-Processing' as it's describing how other (and future) functionalities work.
What do you think @rlanzafame?
Tom-van-Woudenberg
approved these changes
Dec 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.