Fix: more edits from review

Author: lwasser

documentation/repository-files/license-files.md

@@ -47,7 +47,7 @@ To select your license, we suggest that you use GitHub's
 [Choose a License tool ](https://choosealicense.com/).
 
 If you choose your license when creating a new GitHub repository, you can also
-automatically get a text copy of the license file to add to your repo. However
+automatically get a text copy of the license file to add to your repository. However
 in some cases the license that you want is not available through that online
 process.
 
@@ -78,9 +78,9 @@ with the license that you selected for your package.
 :::{admonition} An example of how a license determine how code can be reused
 :class: note
 
-Let's use stackOverflow as an example that highlights how a license determines how code can or can not be used.
+Let's use StackOverflow as an example that highlights how a license determines how code can or can not be used.
 
-[Stack overflow uses a Creative Commons Share Alike license.](https://stackoverflow.com/help/licensing). The sharealike license requires you to use the same sharealike license when you reuse any code from stackoverflow.
+[Stack overflow uses a Creative Commons Share Alike license.](https://stackoverflow.com/help/licensing). The sharealike license requires you to use the same sharealike license when you reuse any code from StackOverflow.
 
 This means that technically, if you copy code from the Stack Overflow website, and use it in your package. And your packages uses a different license such as a MIT license, you are violating Stack Overflow's license requirements!
 
@@ -92,7 +92,7 @@ This means that technically, if you copy code from the Stack Overflow website, a
 
 While many permissive licenses do not require citation we STRONG encourage that you cite all software that you use in papers, blogs and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). We will cover this topic when we talk about creating DOI's for your package using zenodo.
 
-<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with zenodo (do they work??) will the citation info update with a new zenodo link
+<!-- TODO: add link when lesson is created - but also we don't yet know how citation.cff files work with Zenodo (do they work??) will the citation info update with a new Zenodo link
 
 These files - we need to understand if that date releases auto populates or forces zenodo to modify it's citation. if it's not dynamic it could be problematic
 

images/tutorials/view-license-github.png

@@ -16,18 +16,25 @@ In this lesson you will learn:
 3. How you can use the Contributors Covenant website to add generic language as a starting place for your `CODE_OF_CONDUCT`.
 :::
 
-## Add a LICENSE file to your project directory
+## What is a license and why is it important?
 
-A license contains legal language about how users can use and reuse your software. You should include a LICENSE file in your project directory that specifies the license that you choose for your package.
+A license contains legal language about how users can use and reuse your software. To set the LICENSE for your project, you:
+
+1. create LICENSE file in your project directory that specifies the license that you choose for your package and
+2. reference that file in your pyproject.toml data where metadata are set.
+
+By adding the LICENSE file to your pyproject.toml file, the LICENSE will be included in your package's metadata which is used to populate your package's PyPI landing page. It is also used in your GitHub repository (see image below).
+
+### What license should you use?
 
 We suggest that you use a permissive license that accommodates the other most commonly used licenses in the scientific Python ecosystem (MIT[^mit] and BSD-3[^bsd3]). If you are unsure, use MIT given it's the generally recommended
 license on [choosealicense.com](https://choosealicense.com/).
 
 :::{admonition} Licenses for the scientific Python ecosystem
-[We discuss licenses for the scientific Python ecosystem in more detail here in our guidebook.](permissive-license)
+[We discuss licenses for the scientific Python ecosystem in more detail here in our guidebook.](../documentation/repository-files/license-files)
 :::
 
-### Where should the LICENSE file live & how do you add it?
+### Where should the LICENSE file live
 
 Your `LICENSE` file should be placed at the root of your package's repository.
 When you add the LICENSE at the root, GitHub will automagically discover it and
@@ -43,11 +50,15 @@ the license that SunPy uses. These files are discovered by GitHub because they
 are placed in the root of the project directory using standard naming conventions.
 :::
 
-There are several ways to add a license file:
+
+## How to add a LICENSE file to your package repository
+
+There are several ways to add a LICENSE file:
 
 1. When you create a new repository on GitHub, it will ask you if you wish to add a `LICENSE` file at that time. If you select yes, it will create the file for you.
 2. You can add a license through the GitHub gui following the [<i class="fa-brands fa-github"></i> instructions here](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository).
 3. You can add the file manually like we are doing in this lesson.
+4. Or, if you are using a tool such as Hatch, it will add a LICENSE file for you.
 
 :::{tip}
 If you completed the past lessons including
@@ -60,7 +71,7 @@ then you already have a **LICENSE** file containing text for the MIT license in
 If you don't yet have a **LICENSE** file in your directory, then continue reading.
 :::
 
-### How to add a LICENSE to your existing GitHub repository
+### Add a LICENSE to your existing GitHub repository
 
 If you don't already have a LICENSE file, and you are not yet using a platform such as GitHub or GitLab, then you can create a license file by
 
@@ -96,31 +107,32 @@ through the GitHub interface.
 
 :::{figure-md} github-new-repo
 
-<img src="../images/tutorials/github-new-repo.png" alt="Screenshot of the create new repository interface that GitHub provides. The elements of this are the owner and repository name for the new repo. Below that you can add a description of the repo. Below that you can set it to be public or private. At the bottom of the interface there is an Add a README checkbox where it will add a blank readme file for you. At the very bottom there is a line to add a .gitignore file and another to choose a license." width="500px">
+<img src="../images/tutorials/github-new-repo.png" alt="Screenshot of the create new repository interface that GitHub provides. The elements of this are the owner and repository name for the new repo. Below that you can add a description of the repository. Below that you can set it to be public or private. At the bottom of the interface there is an Add a README checkbox where it will add a blank readme file for you. At the very bottom there is a line to add a .gitignore file and another to choose a license." width="500px">
 
 Image showing the GitHub interface that allows you to add a LICENSE and README file when you create a new repository.
 :::
 ::::
 
 ::::{tab-item} Add License: Existing GitHub repository
 
-If you already have a GitHub repository for your package, then you can add a LICENSE using the GitHub interface by adding a new file to the repo.
+If you already have a GitHub repository for your package, then you can add a LICENSE using the GitHub interface by adding a new file to the repository.
 
 - Follow the instructions to select and add a license to your repository on the [GitHub LICENSE page](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) .
 - Once you have added your LICENSE file, be sure to sync your git local repository with the repository on GitHub.com. This means running `git pull` to update your local branch.
 
 :::{figure-md} view-license
-<img src="../images/tutorials/view-license-github.png" alt="sdfsdfsd nasdfjsdf" width="500px">
+<img src="../images/tutorials/view-license-github.png" alt="Image showing what the LICENSE file looks like in the GItHub interface. At the top you can see the actual license which in this image is BSD 3-clause New or revised license. Then there is some text describing both what the license is and the associated permissions for that specific license. At the bottom of the image, the actual text for the license is shown in the LICENSE file." width="500px">
 
-You can also view a summary of the license on its GitHub landing page.```
+You can view a summary of the LICENSE chosen on your project's
+GitHub landing page.
 :::
 ::::
 
 :::::
 ::::::
 
 (add-coc)=
-## Add a CODE_OF_CONDUCT file to your repo
+## Add a CODE_OF_CONDUCT file to your repository
 
 Now that you have added a LICENSE to your project, you are ready to add a `CODE_OF_CONDUCT.md` to your package directory. The `CODE_OF_CONDUCT.md` should be placed at the root of your project directory, similar to the LICENSE file,.
 

tutorials/add-license-coc.md

@@ -62,7 +62,7 @@ If you are using markdown it should be a header 1 tag which is denoted with a si
 It's common for maintainers to add badges to the top of their README files. Badges allow you and your package users to track things like
 
 * Broken documentation and test builds.
-* Versions of your package that are on PyPI and Conda.
+* Versions of your package that are on PyPI and conda.
 * Whether your package has been reviewed and vetted by an organization such as pyOpenSci and/or JOSS.
 
 If you have already published your package to pypi.org you can use [shields.io to create a package version badge](https://shields.io/badges/py-pi-version). This badge will dynamically update as you release new versions of your package to PyPI.

tutorials/add-readme.md

@@ -33,7 +33,7 @@ Get to know Hatch <get-to-know-hatch>
 
 :::{toctree}
 :hidden:
-:caption: Create a Python Package
+:caption: Create and publish a Python Package
 
 What is a Python package? <self>
 Make your code installable <1-installable-code>
@@ -43,11 +43,11 @@ Publish to conda-forge <publish-conda-forge>
 
 :::{toctree}
 :hidden:
-:caption: Citation, License & Project metadata
+:caption: Project information files & metadata
 
 Add README file <add-readme>
-Add a license & COC <add-license-coc>
-Update metadata <pyproject-toml>
+Add a license & code of conduct <add-license-coc>
+Update metadata in pyproject.toml <pyproject-toml>
 :::
 
 :::{admonition} Learning Objectives
@@ -98,7 +98,6 @@ to manage and reuse your code across different projects.
 Structuring your code as a package is the first step you need to take so you can share the tools in the toolbox you've created and let others build with it.
 
 (package-benefits)=
-
 ## Why create a Python package?
 
 You might create a Python package because you want to:
@@ -293,7 +292,7 @@ allows you to access it from any code run with that specific Python environment
 
 :::{figure-md} packages-environment
 
-<img src="../images/tutorials/environment-package-install.png" alt="Diagram showing the steps associated with creating a package and then installing it. The first arrow says your package and the second says pip install package. The second arrow leads to a box that represents a Python environment that already has some packages installed such as pandas and NumPy. Your package will also get installed into that same environment when you pip install it." width="700px">
+<img src="../images/tutorials/environment-package-install.png" alt="Diagram showing the steps associated with creating a package and then installing it. The first arrow says your package and the second says pip install package. The second arrow leads to a box that represents a Python environment that already has some packages installed such as Pandas and NumPy. Your package will also get installed into that same environment when you pip install it." width="700px">
 
 You don't have to publish to PyPI to make your code installable.
 With the correct file structure and project metadata you can make your code
@@ -320,7 +319,7 @@ Then you can create a conda-forge recipe using the [Grayskull](https://github.co
 <img src="../images/tutorials/publish-package-pypi-conda.png" alt="Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to testPyPI or the real PyPI. From PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge." width="700px">
 
 In the image above, you can see the steps associated with publishing
-your package on PyPI and conda-forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda-forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repo. You will learn more about this process in the [conda-forge lesson](#).
+your package on PyPI and conda-forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda-forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repository. You will learn more about this process in the [conda-forge lesson](#).
 :::
 
 ## Yay, your package has users! Now what?