Fix citation information, contact info and broken links in episode 07 (#93)

* replace links to undeveloped episodes with those in the documentation

* replace refrence with a link to citation, fix some links

* remove citation information

* update the references, add more papers

* fix email address

* fix how to cite sections

* try to fix some linter errors

* Update CITATION

Co-authored-by: Bouwe Andela <[email protected]>

* Update _episodes/07-conclusions.md

Co-authored-by: Bouwe Andela <[email protected]>

* Update _episodes/07-conclusions.md

Co-authored-by: Bouwe Andela <[email protected]>

* Update _episodes/07-conclusions.md

Co-authored-by: Bouwe Andela <[email protected]>

* Update _extras/about.md

Co-authored-by: Bouwe Andela <[email protected]>

* Update index.md

Co-authored-by: Bouwe Andela <[email protected]>

* Update index.md

Co-authored-by: Bouwe Andela <[email protected]>

* replace additional resources with the link to esmvaltool reference list

* fix mailing list info

* fix broken links

Co-authored-by: Bouwe Andela <[email protected]>

Author: SarahAlidoost

CITATION

@@ -6,10 +6,12 @@ Please cite this tutorial as:
 
 and cite ESMValTool as:
 
-- Lauer, A., Eyring, V., Bellprat, O., Bock, L., Gier, B. K., Hunter, A.,
-  Lorenz, R., Pérez-Zanón, N., Righi, M., Schlund, M., Senftleben, D., Weigel,
-  K., and Zechlau, S.: Earth System Model Evaluation Tool (ESMValTool) v2.0 –
-  diagnostics for emergent constraints and future projections from Earth
-  system models in CMIP, Geosci. Model Dev. Discuss.,
-  [https://doi.org/10.5194/gmd-2020-60](https://doi.org/10.5194/gmd-2020-60),
-  in review, 2020.
+- Righi, M., Andela, B., Eyring, V., Lauer, A., Predoi, V., Schlund, M.,
+  Vegas-Regidor, J., Bock, L., Brötz, B., de Mora, L., Diblen, F., Dreyer, L.,
+  Drost, N., Earnshaw, P., Hassler, B., Koldunov, N., Little, B., Loosveldt Tomas,
+  S., and Zimmermann, K.:
+  Earth System Model Evaluation Tool (ESMValTool) v2.0 – technical overview,
+  Geosci. Model Dev., 13, 1179–1199, https://doi.org/10.5194/gmd-13-1179-2020,2020.
+
+See additional resources at https://www.esmvaltool.org/references.html.
+

CONTRIBUTING.md

@@ -27,7 +27,7 @@ by our [code of conduct](CODE_OF_CONDUCT.md).
 There are many ways to contribute:
 
 * If you do not have a [GitHub][github] account, you can send us comments by
-  [email][email]. However, we will be able to respond more quickly when you use
+  [email][contact-info]. However, we will be able to respond more quickly when you use
   one of the other methods described below.
 
 * If you have a [GitHub][github] account, work in this
@@ -161,10 +161,8 @@ This address can be opened in your browser to preview the tutorial website.
 
 General discussion of the tutorial happens in
 ESMValTool [User Engagement Team][user-engagement].
-You can reach us by email.
-Please see the [contact information][contact-info].
+Please see [information][contact-info] on how to subscribe to user mailing list.
 
-[email]: mailto:TODO_FIX_ME
 [ESMValTool-site]: https://www.esmvaltool.org/
 [ESMValTool-doc]: https://esmvaltool.readthedocs.io/en/latest/
 [tutorial-repo]: https://esmvalgroup.github.io/ESMValTool_Tutorial/
@@ -177,6 +175,5 @@ Please see the [contact information][contact-info].
 [swc-handbook]: https://carpentries.github.io/curriculum-development/
 [swc-lesson-organization]: https://carpentries.github.io/lesson-example/03-organization/index.html
 [swc-lesson-formatting]: https://carpentries.github.io/lesson-example/04-formatting/index.html
-[ea-site]: https://github.com/escience-academy
 [user-engagement]: https://github.com/orgs/ESMValGroup/teams/userengagementteam
-[contact-info]: https://docs.esmvaltool.org/en/latest/community/contact.html
+[contact-info]: https://docs.esmvaltool.org/en/latest/community/contact.html#user-mailing-list

README.md

@@ -28,7 +28,7 @@ difficulties along the way.
 
 If you work or study in climate-related domains and would be interested in
 getting involved, you can reach us by email.
-Please see the [contact information][contact-info].
+Please see [information][contact-info] on how to subscribe to user mailing list.
 
 ## Authors
 
@@ -43,4 +43,4 @@ To cite this tutorial, please consult with [CITATION](CITATION).
 [tutorial-repo]: https://esmvalgroup.github.io/ESMValTool_Tutorial/
 [tutorial-site]: https://esmvalgroup.github.io/ESMValTool_Tutorial
 [user-engagement]: https://github.com/orgs/ESMValGroup/teams/userengagementteam
-[contact-info]: https://docs.esmvaltool.org/en/latest/community/contact.html
+[contact-info]: https://docs.esmvaltool.org/en/latest/community/contact.html#user-mailing-list

_config.yml

@@ -31,7 +31,7 @@ kind: "lesson"
 repository: <USERNAME>/<PROJECT>
 
 # Email address, no mailto:
-email: "[email protected]"
+email: "[email protected]"
 
 # Sites.
 amy_site: "https://amy.carpentries.org/workshops"

_episodes/01-introduction.md

@@ -86,11 +86,9 @@ let's start with a quick check to synchronize our expectations.
 > {: .solution}
 {: .challenge}
 
-To learn more about ESMValTool, you can look at the
-[documentation](https://docs.esmvaltool.org/en/latest/introduction.html), the
-[official website](https://www.esmvaltool.org/about.html), or the [overview
-paper](https://gmd.copernicus.org/articles/13/1179/2020/) in *Geoscientific
-Model Development*.
+To learn more about ESMValTool, you can look at the section
+``Where can I get more information on ESMValTool?`` in the lesson
+[Conclusion of the basic tutorial]({{ page.root }}{% link _episodes/07-conclusions.md %}).
 
 ## How does ESMValTool work
 

_episodes/07-conclusions.md

@@ -13,23 +13,35 @@ objectives:
 - "breathe - you're finished now!"
 - "Congratulations & Thanks!"
 - "Find out about the mini-tutorials, and what to do next."
+
+keypoints:
+- "Individual mini-tutorials help work through a specific issue (not developed yet)."
+- "We are constantly improving this tutorial."
 ---
 
 ## Congratulations!
 
-Congratulations on completing the ESMValTool tutorial! You should be now ready to go and start using ESMValTool independently. 
-
-The rest of this tutorial contains individual mini-tutorials to help work through a specific issue. 
+Congratulations on completing the ESMValTool tutorial!
+You should be now ready to go and start using ESMValTool independently.
 
+The rest of this tutorial contains individual mini-tutorials
+to help work through a specific issue (not developed yet).
 
 ### What next?
 
 From here, there are lots of ways that you can continue to use ESMValTool.
 
-- You can start from the list of existing recipes and run one of those. [LINK to ep 8]
-- You can learn how to write your own diagnostics and recipes. [LINK to ep 9]
-- You can contribute your recipe and diagnostics back into ESMValTool. [Link to ep 10]
-- You can learn how to prepare observational datasets to be suitable for use by ESMValTool. [ Link to ep 11]
+- You can start from the list of
+[existing recipes](https://docs.esmvaltool.org/en/latest/recipes/index.html)
+and run one of those.
+- You can learn how to
+[write your own diagnostics and recipes](https://docs.esmvaltool.org/en/latest/develop/index.html).
+- You can
+[contribute your recipe and diagnostics](https://docs.esmvaltool.org/en/latest/community/index.html)
+back into ESMValTool.
+- You can learn how to prepare
+[observational datasets](https://docs.esmvaltool.org/en/latest/input.html#observations)
+to be suitable for use by ESMValTool.
 
 > ## `Exercise: What do you want to do next?`
 >
@@ -38,101 +50,47 @@ From here, there are lots of ways that you can continue to use ESMValTool.
 >   - Is any observational data available?
 >   - How will you preprocess the data?
 >   - What will your diagnostic script need to do?
->   - What will your final figure show? 
+>   - What will your final figure show?
 {: .challenge}
 
 ### Where can I get more information on ESMValTool?
 
-> ## Additional resources: 
-> - [Read the docs page](https://esmvaltool.readthedocs.io/)
+> ## Additional resources:
+>
+> - [Documenation](https://docs.esmvaltool.org)
 > - [ESMValTool home page](https://www.esmvaltool.org/)
-> - [Technical description paper](https://doi.org/10.5194/gmd-13-1179-2020)
+> - [Papers](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/CITATION)
 > - [Source code (ESMValTool)](https://github.com/ESMValGroup/ESMValTool)
 > - [Source code (ESMValCore )](https://github.com/ESMValGroup/ESMValCore)
 {: .callout}
 
 
-Additional publications:
-- Lauer, A., Eyring, V., Bellprat, O., Bock, L., Gier, B. K., Hunter, A., Lorenz, R., 
-  Pérez-Zanón, N., Righi, M., Schlund, M., Senftleben, D., Weigel, K., and Zechlau, S.:
-Earth System Model Evaluation Tool (ESMValTool) v2.0 – diagnostics
-for emergent constraints and future projections from Earth system models in CMIP,
-Geosci. Model Dev. Discuss.,
-[https://doi.org/10.5194/gmd-2020-60](https://doi.org/10.5194/gmd-2020-60), in review, 2020.
-
-- Eyring, V., Bock, L., Lauer, A., Righi, M., Schlund, M., Andela, B., Arnone, E., 
-  Bellprat, O., Brötz, B., Caron, L.-P., Carvalhais, N., Cionni, I., Cortesi, N., Crezee, B., 
-  Davin, E., Davini, P., Debeire, K., de Mora, L., Deser, C., Docquier, D., Earnshaw, P., 
-  Ehbrecht, C., Gier, B. K., Gonzalez-Reviriego, N., Goodman, P., Hagemann, S., 
-  Hardiman, S., Hassler, B., Hunter, A., Kadow, C., Kindermann, S., Koirala, S., 
-  Koldunov, N. V., Lejeune, Q., Lembo, V., Lovato, T., Lucarini, V., Massonnet, F., 
-  Müller, B., Pandde, A., Pérez-Zanón, N., Phillips, A., Predoi, V., Russell, J., Sellar, A., 
-  Serva, F., Stacke, T., Swaminathan, R., Torralba, V., Vegas-Regidor, J., von Hardenberg, J., 
-  Weigel, K., and Zimmermann, K.: 
-  ESMValTool v2.0 – Extended set of large-scale diagnostics for quasi-operational 
-  and comprehensive evaluation of Earth system models in CMIP, 
-  Geosci. Model Dev. Discuss., 
-  [https://doi.org/10.5194/gmd-2019-291](https://doi.org/10.5194/gmd-2019-291),
-   in review, 2019.
-
-- Eyring, V., Righi, M., Lauer, A., Evaldsson, M., Wenzel, S., Jones, C., Anav, A.,
-  Andrews, O., Cionni, I., Davin, E. L., Deser, C., Ehbrecht, C., Friedlingstein, P., 
-  Gleckler, P., Gottschaldt, K.-D., Hagemann, S., Juckes, M., Kindermann, S., 
-  Krasting, J., Kunert, D., Levine, R., Loew, A., Mäkelä, J., Martin, G., Mason, E., 
-  Phillips, A. S., Read, S., Rio, C., Roehrig, R., Senftleben, D., Sterl, A., 
-  van Ulft, L. H., Walton, J., Wang, S., and Williams, K. D.: 
-  ESMValTool (v1.0) – a community diagnostic and performance metrics tool for 
-  routine evaluation of Earth system models in CMIP, 
-  Geosci. Model Dev., 9, 1747–1802, 
-  [https://doi.org/10.5194/gmd-9-1747-2016](https://doi.org/10.5194/gmd-9-1747-2016),
-  2016.
-
-
 ### Where can I get more help?
 
-There are lots of resources available for helping you use ESMValTool. 
-
-If you get stuck, a great starting point is to create a new issue. [Link to ep 10]
-
-There is also an ESMValTool email list [[email protected]](mailto:[email protected]).
+There are lots of resources available for helping you use ESMValTool.
 
-Everybody can send mail without being subscribed to the group, but note that there is a spam filter.
-The email group archive is also [online](https://www.listserv.dfn.de/sympa/arc/esmvaltool/2020-06/).
+If you get stuck, a great starting point is to create a
+[new issue](https://github.com/ESMValGroup/ESMValTool/issues/new/choose).
 
+There is also an ESMValTool email list.
+Please see
+[information](https://docs.esmvaltool.org/en/latest/community/contact.html#user-mailing-list)
+on how to subscribe to user mailing list.
 
-### What if I find a bug? 
+### What if I find a bug?
 
-If you find a bug, please report it back to the ESMValTool team. 
-This will help us fix it so that you can continue working, 
-but also it means that ESMValTool will be more stable for everyone else as well. 
+If you find a bug, please report it back to the ESMValTool team.
+This will help us fix it, so that you can continue working,
+but also it means that ESMValTool will be more stable for everyone else as well.
 
-To report a bug, please create a new issue using the 
+To report a bug, please create a new issue using the
 [new issue page](https://github.com/ESMValGroup/ESMValTool/issues/new/choose).
 
-In your bug report, please describe the problem as clearly and as completely as possible. 
+In your bug report, please describe the problem as clearly and as completely as possible.
 You may need to include a recipe or the output log as well.
 
+### How do I cite the Tutorial and ESMValTool?
 
-### How do I cite ESMValTool?
-
-Please cite ESMValTool as:
-
-- Lauer, A., Eyring, V., Bellprat, O., Bock, L., Gier, B. K., Hunter, A., 
-  Lorenz, R., Pérez-Zanón, N., Righi, M., Schlund, M., Senftleben, D., 
-  Weigel, K., and Zechlau, S.: 
-  Earth System Model Evaluation Tool (ESMValTool) v2.0 – diagnostics for 
-  emergent constraints and future projections from Earth system models in CMIP, 
-  Geosci. Model Dev. Discuss., 
-  [https://doi.org/10.5194/gmd-2020-60](https://doi.org/10.5194/gmd-2020-60), 
-  in review, 2020.
-
-
-Please cite this tutorial as:
-
-- ESMValTool 2.0 tutorial, ESMValTool developers, version [ADD VERSION],
-  [https://github.com/ESMValGroup/tutorial](https://github.com/ESMValGroup/tutorial),
-  [DATE].
-
-
+Please see [citation information](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/CITATION).
 
 {% include links.md %}

_extras/about.md

@@ -24,8 +24,9 @@ ESMValTool is open source and available on github, and is written
 in PEP8-compliant Python3.
 
 For more details on ESMValTool, please go to:
-- [https://esmvaltool.org](ESMValTool home page)
-- [https://esmvaltool.readthedocs.io/](ESMValTool Read The Docs page)
+
+- [ESMValTool home page](https://esmvaltool.org)
+- [ESMValTool Documentation page](https://docs.esmvaltool.org)
 
 
 ## ESMValTool_Tutorial
@@ -39,28 +40,17 @@ followed both independently and in a taught tutorial environment.
 The tutorial has been produced by the ESMValTool User Engagement team,
 and may be forked, developped and rehosted by other groups.
 
-
 ## License
+
 The ESMValTool is released under the Apache License, version 2.0. Citation of
 the ESMValTool paper (“Software Documentation Paper”) is kindly requested upon use,
 alongside with the software DOI for ESMValTool (doi:10.5281/zenodo.3401363)
-and ESMValCore (doi:10.5281/zenodo.3387139) and version number:
+and ESMValCore (doi:10.5281/zenodo.3387139) and version number.
 
 ## Citation
 
-Please cite ESMValTool using:
-
-Righi, M., Andela, B., Eyring, V., Lauer, A., Predoi, V., Schlund, M.,
-Vegas-Regidor, J., Bock, L., Brötz, B., de Mora, L., Diblen, F., Dreyer, L.,
-Drost, N., Earnshaw, P., Hassler, B., Koldunov, N., Little, B., Loosveldt Tomas,
-S., and Zimmermann, K.:
-Earth System Model Evaluation Tool (ESMValTool) v2.0 – technical overview,
-Geosci. Model Dev., 13, 1179–1199, https://doi.org/10.5194/gmd-13-1179-2020,
-2020.
-
-Besides the above citation, users are kindly asked to register any journal article
-(or other scientific documents) that use the software at the ESMValTool webpage
-(http://www.esmvaltool.org/).
+Please see
+[citation information](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/CITATION).
 
 Citing the Software Documentation Paper and registering your papers
 will serve to document the scientific impact of the Software,
@@ -70,7 +60,6 @@ You should consider this an obligation if you have taken advantage of the
 ESMValTool, which represents the end product of considerable effort by the
 development teams.
 
-
 ## Acknowledgements
 
 The technical development work for ESMValTool v2.0 was funded by various projects,

index.md

@@ -51,38 +51,27 @@ independently.
 3. If you get stuck, help is always available from the tutors, from ESMValTool
     developers via the [github issues
     page](https://github.com/ESMValGroup/ESMValTool/issues) or via the
-    [ESMValTool email list](mailto:[email protected]).
+    ESMValTool email list. Please see
+    [information](https://docs.esmvaltool.org/en/latest/community/contact.html#user-mailing-list)
+    on how to subscribe to user mailing list.
 
 4. This tutorial includes several advanced lessons after the conclusion. These
    advanced lessons should be treated like “mini-tutorials”, and include aspects
    like “developing your own diagnostic” or “how to include observations”.
 
 > ## Additional Resources
 >
-> - [Read the docs page](https://esmvaltool.readthedocs.io/)
+> - [Documentation](https://docs.esmvaltool.org)
 > - [ESMValTool home page](https://www.esmvaltool.org/)
-> - [Technical description paper](https://doi.org/10.5194/gmd-13-1179-2020)
+> - [Papers](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/CITATION)
 > - [ESMValTool Source code](https://github.com/ESMValGroup/ESMValTool)
 > - [ESMValCore Source code](https://github.com/ESMValGroup/ESMValCore)
 >
 {: .callout}
 
-## How to cite ESMValTool
+## How to cite the Tutorial and ESMValTool
 
-Please cite this tutorial as:
-
-- ESMValTool 2.0 tutorial, ESMValTool developers, version [ADD VERSION],
-  [https://github.com/ESMValGroup/tutorial](https://github.com/ESMValGroup/tutorial),
-  [DATE].
-
-Please cite ESMValTool as:
-
-- Lauer, A., Eyring, V., Bellprat, O., Bock, L., Gier, B. K., Hunter, A.,
-  Lorenz, R., Pérez-Zanón, N., Righi, M., Schlund, M., Senftleben, D., Weigel,
-  K., and Zechlau, S.: Earth System Model Evaluation Tool (ESMValTool) v2.0 –
-  diagnostics for emergent constraints and future projections from Earth
-  system models in CMIP, Geosci. Model Dev. Discuss.,
-  [https://doi.org/10.5194/gmd-2020-60](https://doi.org/10.5194/gmd-2020-60),
-  in review, 2020.
+Please see
+[citation information](https://github.com/ESMValGroup/ESMValTool_Tutorial/blob/master/CITATION).
 
 {% include links.md %}