Update docs to use release_notes.rst instead of changelog.rst

contributing.md

@@ -61,7 +61,7 @@ The code is hosted on GitHub, so you will need to use Git to clone the project a
     * API changes - if you change the API update `docs/source/api_reference.rst`
     * Documentation - run the documentation notebooks locally to ensure everything is logical and works as intended
 
-* Update the "Future Release" section at the top of the changelog (`docs/source/changelog.rst`) to include an entry for your pull request. Write your entry in past tense, i.e. "added fizzbuzz impl."
+* Update the "Future Release" section at the top of the release notes (`docs/source/release_notes.rst`) to include an entry for your pull request. Write your entry in past tense, i.e. "added fizzbuzz impl."
 
 Add a description of your PR to the subsection that most closely matches your contribution:
     * Enhancements: new features or additions to EvalML.
@@ -70,7 +70,7 @@ Add a description of your PR to the subsection that most closely matches your co
     * Documentation Changes
     * Testing Changes
 
-If your work includes a [breaking change](https://en.wiktionary.org/wiki/breaking_change), please add a description of what has been affected in the "Breaking Changes" section below the latest changelog. If no "Breaking Changes" section yet exists, please create one as follows. See past changelogs for examples of this.
+If your work includes a [breaking change](https://en.wiktionary.org/wiki/breaking_change), please add a description of what has been affected in the "Breaking Changes" section below the latest release notes. If no "Breaking Changes" section yet exists, please create one as follows. See past release notes for examples of this.
 ```
 .. warning::
 

docs/source/install.ipynb

@@ -26,7 +26,7 @@
     "\n",
     "```bash\n",
     "pip install evalml --no-dependencies\n",
-    "pip instal -r core-requirements.txt\n",
+    "pip install -r core-requirements.txt\n",
     "```"
    ]
   },

docs/source/release_notes.rst

@@ -1,5 +1,3 @@
-.. _changelog:
-
 Release Notes
 -------------
 
@@ -32,6 +30,7 @@ Release Notes
     * Documentation Changes
         * Reorganized and rewrote documentation :pr:`937`
         * Updated to use pydata sphinx theme :pr:`937`
+        * Updated docs to use `release_notes` instead of `changelog` :pr:`942`
     * Testing Changes
         * Cleaned up fixture names and usages in tests :pr:`895`
 

pull_request_template.md

@@ -2,4 +2,4 @@
 (replace this text with your description)
 
 -----
-*After creating the pull request: in order to pass the **changelog_updated** check you will need to update the "Future Release" section of* `docs/source/changelog.rst` *to include this pull request by adding :pr:`123`.*
+*After creating the pull request: in order to pass the **release_notes_updated** check you will need to update the "Future Release" section of* `docs/source/release_notes.rst` *to include this pull request by adding :pr:`123`.*

release.md

@@ -5,25 +5,25 @@ Before starting the release process, verify the following:
 * All work required for this release has been completed and the team is ready to release.
 * [All CircleCI tests are green on main](https://app.circleci.com/pipelines/github/FeatureLabs/evalml?branch=main).
 * The [ReadtheDocs build](https://readthedocs.com/projects/feature-labs-inc-evalml/builds/) for "latest" is marked as passed. To avoid mysterious errors, best practice is to empty your browser cache when reading new versions of the docs!
-* The [public documentation for the "latest" branch](https://evalml.featurelabs.com/en/latest/) looks correct, and the [changelog](https://evalml.featurelabs.com/en/latest/changelog.html) includes the last change which was made on main.
+* The [public documentation for the "latest" branch](https://evalml.featurelabs.com/en/latest/) looks correct, and the [release notes](https://evalml.featurelabs.com/en/latest/release_notes.html) includes the last change which was made on main.
 * The [performance tests](https://github.com/FeatureLabs/evalml-performance-tests) have passed on latest main, and the team has reviewed the results.
 
-## 1. Create release PR to update version and changelog
-Please use the following pattern for the release PR branch name: "release_vX.X.X". Doing so will bypass our changelog checkin test which requires all other PRs to add a changelog entry.
+## 1. Create release PR to update version and release notes
+Please use the following pattern for the release PR branch name: "release_vX.X.X". Doing so will bypass our release notes checkin test which requires all other PRs to add a release note entry.
 
 Create a release PR with the following changes:
 * Update `setup.py` and `evalml/__init__.py` to bump `__version__` to the new version.
-* Move all entries in `docs/source/changelog.rst` currently listed under `**Future Releases**` to be under a new heading with the version number and release date.
+* Move all entries in `docs/source/release_notes.rst` currently listed under `**Future Releases**` to be under a new heading with the version number and release date.
 * Make sure `**Future Releases**` is empty except for the sub-headings, so its ready for new entries.
-* Populate the release PR body with a copy of this release's changelog, reformatted to [GitHub markdown](https://guides.github.com/features/mastering-markdown/). You'll reuse this text in step 2. This is currently done by hand and can be done faster with some clever text editor features.
-* Confirm that all release items are in the changelog under the correct header, and that no extra items are listed. You may have to do an "empty cache and hard reset" in your browser to see updates.
+* Populate the release PR body with a copy of this release's release notes, reformatted to [GitHub markdown](https://guides.github.com/features/mastering-markdown/). You'll reuse this text in step 2. This is currently done by hand and can be done faster with some clever text editor features.
+* Confirm that all release items are in the release notes under the correct header, and that no extra items are listed. You may have to do an "empty cache and hard reset" in your browser to see updates.
 
 An example can be found here: https://github.com/FeatureLabs/evalml/pull/163
 
 Checklist before merging:
 * PR has been reviewed and approved.
 * All tests are currently green on checkin and on main.
-* The ReadtheDocs build for the release PR branch has passed, and the resulting docs contain the expected changelog.
+* The ReadtheDocs build for the release PR branch has passed, and the resulting docs contain the expected release notes.
 * Confirm with the team that `main` will be frozen until step 3 (github release) is complete.
 
 After merging, verify again that ReadtheDocs "latest" is correct.
@@ -33,7 +33,7 @@ After the release pull request has been merged into the main branch, it is time
 * The target should be the main branch, which is the default value.
 * The tag should be the version number with a "v" prefix (e.g. "vX.X.X").
 * The release title is the same as the tag, "vX.X.X"
-* The release description should be the full changelog updates for the release, reformatted as GitHub markdown (from the release PR body in step 1).
+* The release description should be the full release notes updates for the release, reformatted as GitHub markdown (from the release PR body in step 1).
 
 Note that by targeting `main`, there must be no new merges to `main` from the moment we merge the release PR to when we publish the new GitHub release. Otherwise, the release will point at the wrong commit on `main`!