Skip to content

Conversation

@vmartinez-cu
Copy link
Collaborator

This PR adds 3 new guides that port over information from the data management confluence page that are related to publishing and citing datasets

@vmartinez-cu vmartinez-cu requested a review from Copilot August 7, 2025 20:00
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds dataset publishing and citation documentation by porting content from the LASP data management Confluence page. The changes provide comprehensive guidance on Digital Object Identifiers (DOIs), dataset publishing workflows, and citation practices.

  • Adds three new documentation guides covering DOI fundamentals, creation processes, and dataset publishing/citation practices
  • Integrates these guides into the existing data management documentation structure
  • Provides practical workflows for LASP researchers to create DOIs through CU Libraries and DataCite

Reviewed Changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.

File Description
docs/source/data_management/index.rst Adds new guide files to the documentation table of contents
docs/source/data_management/digital_object_identifiers.md Comprehensive introduction to DOIs, their purpose, format, and registries
docs/source/data_management/creating_a_doi.md Step-by-step guide for creating DOIs via CU Libraries and DataCite
docs/source/data_management/citing_and_publishing_datasets.md Guidelines for publishing datasets and proper citation practices

@vmartinez-cu vmartinez-cu added the Topic Pertains to a specific topic within the developer guide label Aug 7, 2025
@vmartinez-cu
Copy link
Collaborator Author

I'm not sure how to bypass a codespell error. It thinks there's a typo in the word "SORCE" but it's a mission name and is spelled correctly.

docs/source/data_management/citing_and_publishing_datasets.md:60: SORCE ==> SOURCE, FORCE, SORE

@bourque
Copy link
Member

bourque commented Aug 8, 2025

I'm not sure how to bypass a codespell error. It thinks there's a typo in the word "SORCE" but it's a mission name and is spelled correctly.

docs/source/data_management/citing_and_publishing_datasets.md:60: SORCE ==> SOURCE, FORCE, SORE

@vmartinez-cu I think you could you add something in pyproject.toml to ignore this word? Here is how we do it in imap_processing: https://github.com/IMAP-Science-Operations-Center/imap_processing/blob/c1e337e73aadcb71ccbc5c11765db42314fd8069/pyproject.toml#L119

Copy link
Member

@bourque bourque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These looks great! Thanks for adding all of this content ahead of our presentation!

@vmartinez-cu vmartinez-cu merged commit d5a5106 into lasp:main Aug 8, 2025
8 checks passed
@vmartinez-cu vmartinez-cu deleted the publishing-datasets branch August 8, 2025 21:01
bourque added a commit that referenced this pull request Sep 4, 2025
* Add guidelines on citing and publishing datasets

* Add images used in a couple data managment guides

* Minor fixes to typos and file paths

* Add "SORCE" to words codespell should ignore in poetry toml

---------

Co-authored-by: Matthew Bourque <Matthew.Bourque@lasp.colorado.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Topic Pertains to a specific topic within the developer guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants