From 8fc95efd96d0ccc6ffb7dfca3a17833669a242e0 Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Mon, 18 Dec 2023 16:42:45 +0100 Subject: [PATCH 1/5] add workflow for new chapters / corrections --- README.md | 5 +++++ book/_quarto.yml | 1 + book/chapters/appendices/errata.qmd | 12 ++++++++++++ 3 files changed, 18 insertions(+) create mode 100644 book/chapters/appendices/errata.qmd diff --git a/README.md b/README.md index 2c274bd84..fac2d944e 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,11 @@ If you are making changes to the book please note the following: * Our style guide is provided [here in the introduction](https://mlr3book.mlr-org.com/chapters/chapter1/introduction_and_overview.html#styleguide) * Where possible, figures in the HTML book should be svgs and figures in the PDF should be pdf. These should be included with `knitr::include_graphics()` or ideally with [include_multi_graphics()](https://github.com/mlr-org/mlr3book/blob/main/book/common/_utils.qmd). + +When (non-trivial) changes and corrections are made to chapters that are are included in the first published edition of this book, these changes should be documented in the *Errata* appendix. +When adding new chapters to the book not present in the published version, these should be marked as *Online Only*. +For such newly added chapters that are in early stages and have not been rigorously edited and reviewed,, these should be additionally marked as being a *Draft*. + * If you add a new package dependency to the book, please follow the following steps to update the lockfile: * Start an R session in the `book/` directory * Activate the project with `renv::activate()` diff --git a/book/_quarto.yml b/book/_quarto.yml index 5a2d660eb..e9868b338 100644 --- a/book/_quarto.yml +++ b/book/_quarto.yml @@ -49,6 +49,7 @@ book: - chapters/appendices/solutions.qmd # online only - chapters/appendices/tasks.qmd # online only - chapters/appendices/overview-tables.qmd # online only + - chapters/appendices/errata.qmd # online only bibliography: book.bib diff --git a/book/chapters/appendices/errata.qmd b/book/chapters/appendices/errata.qmd new file mode 100644 index 000000000..b50597232 --- /dev/null +++ b/book/chapters/appendices/errata.qmd @@ -0,0 +1,12 @@ +--- +aliases: + - "/errata.html" +--- + +# Errata {#sec-appendix-errata} + +::: {.content-visible when-format="html"} + +{{< include ../../common/_setup.qmd >}} + +This appendix lists changes to the online version of this book to chapters included in the original publication. From 3d2ea7c89636e540b3a0d4c4b890296402b3c83a Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Mon, 15 Jan 2024 15:40:52 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fac2d944e..f7318f620 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ If you are making changes to the book please note the following: * Where possible, figures in the HTML book should be svgs and figures in the PDF should be pdf. These should be included with `knitr::include_graphics()` or ideally with [include_multi_graphics()](https://github.com/mlr-org/mlr3book/blob/main/book/common/_utils.qmd). When (non-trivial) changes and corrections are made to chapters that are are included in the first published edition of this book, these changes should be documented in the *Errata* appendix. -When adding new chapters to the book not present in the published version, these should be marked as *Online Only*. +When adding new chapters to the book not present in the published version, these should be marked as *Online Only* in their title. For such newly added chapters that are in early stages and have not been rigorously edited and reviewed,, these should be additionally marked as being a *Draft*. * If you add a new package dependency to the book, please follow the following steps to update the lockfile: From 270bdfbc2f73f8ef48c2ec375ab0e9d63aa20e2d Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Mon, 15 Jan 2024 15:40:59 +0100 Subject: [PATCH 3/5] Update book/chapters/appendices/errata.qmd --- book/chapters/appendices/errata.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/chapters/appendices/errata.qmd b/book/chapters/appendices/errata.qmd index b50597232..9d3a4dfbb 100644 --- a/book/chapters/appendices/errata.qmd +++ b/book/chapters/appendices/errata.qmd @@ -9,4 +9,4 @@ aliases: {{< include ../../common/_setup.qmd >}} -This appendix lists changes to the online version of this book to chapters included in the original publication. +This appendix lists changes to the online version of this book to chapters included in the first edition of the book. From 35d40f4333362de099544d0a43ccef7eb6a8cfbd Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Tue, 16 Jan 2024 08:57:34 +0100 Subject: [PATCH 4/5] Update book/chapters/appendices/errata.qmd --- book/chapters/appendices/errata.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/chapters/appendices/errata.qmd b/book/chapters/appendices/errata.qmd index 9d3a4dfbb..0f0954a42 100644 --- a/book/chapters/appendices/errata.qmd +++ b/book/chapters/appendices/errata.qmd @@ -9,4 +9,4 @@ aliases: {{< include ../../common/_setup.qmd >}} -This appendix lists changes to the online version of this book to chapters included in the first edition of the book. +This appendix lists changes to the online version of this book to chapters included in the first edition. From 1040154fa10f28020ce516c86347bca2c7b57060 Mon Sep 17 00:00:00 2001 From: Sebastian Fischer Date: Tue, 16 Jan 2024 08:57:38 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f7318f620..f8daf8b24 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ If you are making changes to the book please note the following: When (non-trivial) changes and corrections are made to chapters that are are included in the first published edition of this book, these changes should be documented in the *Errata* appendix. When adding new chapters to the book not present in the published version, these should be marked as *Online Only* in their title. -For such newly added chapters that are in early stages and have not been rigorously edited and reviewed,, these should be additionally marked as being a *Draft*. +For such newly added chapters that are in early stages and have not been rigorously edited and reviewed, these should be additionally marked as being a *Draft*. * If you add a new package dependency to the book, please follow the following steps to update the lockfile: * Start an R session in the `book/` directory