Skip to content

Commit 166c034

Browse files
committed
fix: Add history, update CONTRIBUTING, and move Technical Details into CONTRIBUTING
1 parent 54bcc31 commit 166c034

6 files changed

Lines changed: 101 additions & 28 deletions

File tree

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing
2+
3+
## How to Contribute
4+
5+
The UA Libraries Scholarly API Cookbook is an open source resource. Contributions from students, faculty, staff, and the broader community are welcome.
6+
7+
### Reporting Errors or Suggesting Improvements
8+
9+
If you find an error, outdated code, broken link, or unclear explanation, please open an issue in the [GitHub Issues](https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/issues).
10+
11+
When creating an issue, it is helpful to include:
12+
13+
- A link to the specific tutorial page
14+
- A description of the issue
15+
- Any relevant error messages
16+
- Suggested corrections (if available)
17+
18+
We review issues regularly and will respond as soon as possible.
19+
20+
### Requesting New APIs or Tutorials
21+
22+
If you would like to see support for a specific scholarly API, please open a GitHub issue describing:
23+
24+
- The name of the API
25+
- A link to its official documentation
26+
- Why it would be useful for research or teaching
27+
- Whether the API is open access or requires institutional credentials
28+
29+
### Submitting Code Contributions
30+
31+
Before submitting a pull request, please open an issue to discuss proposed changes. This helps ensure alignment with project goals and avoids duplicated work.
32+
33+
For tutorial contributions:
34+
35+
- Follow existing Python or R tutorial structure and formatting, particularly as it relates to licensing, external packages, and API authentication.
36+
- Ensure all code runs without errors.
37+
- Include clear explanations and comments.
38+
- Avoid hard-coded credentials or private API keys.
39+
40+
All contributions are reviewed for accuracy, clarity, reproducibility, and consistency with project standards.
41+
42+
## Project Scope
43+
44+
As of 2025, the Cookbook focuses on maintaining and standardizing Python and R tutorials. Other language have been archived and are no longer actively maintained.
45+
46+
### Project Infrastructure
47+
48+
The Scholarly API Cookbook is built using the following tools:
49+
50+
- Python tutorials are written in [Jupyter Notebooks](https://jupyter.org/).
51+
- R tutorials are written in RMarkdown and exported to Markdown.
52+
- Narrative content is written in [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html).
53+
- The site is compiled using [Jupyter Book](https://jupyterbook.org/).
54+
- An automated GitHub workflow builds the site and deploys it using [GitHub Actions](https://docs.github.com/en/actions).
55+
56+
Contributors should ensure that all notebooks and Markdown files build successfully before submitting changes.
57+
58+
## Questions
59+
60+
If you are unsure whether an idea fits the project scope, please open an issue to start a discussion.

src/_toc.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,9 @@ parts:
274274
- file: r/usa-spending
275275
title: "...in R"
276276

277+
277278
- caption: ABOUT
278279
chapters:
279-
- file: about/contributing
280+
- file: about/history
281+
- file: about/contributing # Note: This page redirects to CONTRIBUTING.md
280282
- file: about/license-reuse
281-
- file: about/tech-details

src/about/contributing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../CONTRIBUTING.md
2+
```

src/about/contributing.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

src/about/history.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
History
2+
%%%%%%%
3+
4+
Brief History of the UA Libraries Scholarly API Cookbook
5+
********************************************************
6+
7+
In late 2019, as Research Data Services was formalized within UA Libraries under the leadership
8+
of Dr. Kevin Walker, we developed an interest in supporting users with programmatic access to
9+
information through Scholarly APIs. During this time, Dr. Vincent Scalfani started writing
10+
Scholarly API tutorials related to chemistry and bibliographic APIs.
11+
12+
We soon saw the value in a broad range of disciplinary API tutorials and started a coordinated
13+
effort to create the UA Libraries Scholarly API Cookbook in 2021. We built a team of UA student
14+
developers, which quickly brought the Cookbook from an idea to a coordinated open education
15+
documentation project. Vishank Patel and Anastasia Ramig wrote the early Mathematica and MATLAB
16+
tutorials, respectively. Avery Fernandez set up the original Jupyter Book and automated builds
17+
on GitHub and wrote numerous Python and Bash tutorials (and later re-wrote many of them!).
18+
Adam Nguyen filled a gap in scripting languages by writing the first collection of R tutorials,
19+
and Cyrus Gomes translated tutorials to C.
20+
21+
There have been many other contributions from talented students including Sebastian Shirk, Jay
22+
Crawford, Nate Pedigo, and Michael Moen. In addition to contributing tutorials, in 2023,
23+
Michael started to lead the maintenance of the Cookbook, including testing, reviewing, merging
24+
contributions, and adding other improvements to the build workflow and metadata. By early 2025,
25+
we had approached nearly 100 tutorials across six different programming languages. We made the
26+
decision to `archive`_ many of the tutorials and focus our efforts on standardizing and
27+
maintaining the Python and R tutorials moving forward. Michael Moen has since led this Cookbook
28+
standardization effort and serves as our student lead maintainer for the Scholarly API Cookbook.
29+
30+
From 2021-2025, Dr. Vincent Scalfani supervised the day-to-day operations of the Scholarly API
31+
Cookbook, assisting students with code, use-case ideas, and final review. This supervisory role
32+
shifted to other Research Computing staff and faculty in 2025. Currently, Dr. Rachel DuBose and
33+
Dakeya Chambers lead the supervision and reviews for the Scholarly API Cookbook, with Chambers
34+
providing daily, hands on oversight throughout the process.
35+
36+
.. _archive: https://github.com/UA-Libraries-Research-Data-Services/Scholarly_API_Cookbook_Archive

src/about/tech-details.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)