Add CHANGELOG section to rest of README templates

AlexsLemonade · Nov 9, 2023 · 7556650 · 7556650
1 parent 15171c5
commit 7556650
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/api/scpca_portal/templates/readme_anndata.md b/api/scpca_portal/templates/readme_anndata.md
@@ -36,6 +36,10 @@ See the [Downloadable files](https://scpca.readthedocs.io/en/stable/download_fil
 For instructions on using the HDF5 files, please see [FAQ: How do I use the provided HDF5 files in Python?](https://scpca.readthedocs.io/en/stable/faq.html#how-do-i-use-the-provided-HDF5-files-in-python)
 For more information on working with the processed `AnnData` objects, see [`Getting started with an ScPCA dataset`](https://scpca.readthedocs.io/en/stable/getting_started.html).
 
+## CHANGELOG
+
+A summary of changes impacting downloads from the ScPCA Portal is available in [the CHANGELOG section of our documentation](https://scpca.readthedocs.io/en/stable/CHANGELOG.html).
+
 ## Contact
 
 If you identify issues with this download, please [file an issue on GitHub.](https://github.com/AlexsLemonade/scpca-portal/issues/new) If you would prefer to report issues via e-mail, please contact us at [[email protected]](mailto:[email protected]).

diff --git a/api/scpca_portal/templates/readme_multiplexed.md b/api/scpca_portal/templates/readme_multiplexed.md
@@ -36,6 +36,10 @@ For instructions on using the RDS files, please see [FAQ: How do I use the provi
 
 For information on how to use the demultiplexing results that the filtered data files contains, see the ["Getting started" section about multiplex samples](https://scpca.readthedocs.io/en/stable/getting_started.html#special-considerations-for-multiplexed-samples).
 
+## CHANGELOG
+
+A summary of changes impacting downloads from the ScPCA Portal is available in [the CHANGELOG section of our documentation](https://scpca.readthedocs.io/en/stable/CHANGELOG.html).
+
 
 ## Contact
 

diff --git a/api/scpca_portal/templates/readme_spatial.md b/api/scpca_portal/templates/readme_spatial.md
@@ -25,6 +25,10 @@ See the [Downloadable files](https://scpca.readthedocs.io/en/stable/download_fil
 
 For more information on how the spatial libraries were processed, see the [Spatial Transcriptomics section in the Processing information](https://scpca.readthedocs.io/en/stable/processing_information.html#spatial-transcriptomics) page of the ScPCA Portal documentation.
 
+## CHANGELOG
+
+A summary of changes impacting downloads from the ScPCA Portal is available in [the CHANGELOG section of our documentation](https://scpca.readthedocs.io/en/stable/CHANGELOG.html).
+
 ## Contact
 
 If you identify issues with this download, please [file an issue on GitHub.](https://github.com/AlexsLemonade/scpca-portal/issues/new) If you would prefer to report issues via e-mail, please contact us at [[email protected]](mailto:[email protected]).