Skip to content

Commit a819d3e

Browse files
larsvilhuberlarsvilhuber
authored
Merge pull request #4 from AEADataEditor/workflow-edits
Workflow edits
2 parents 744cffd + c23178a commit a819d3e

10 files changed

Lines changed: 115 additions & 54 deletions

File tree

‎.github/workflows/deploy-jb.yml‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242

4343
steps:
4444
- name: Checkout repo
45-
uses: actions/checkout@v4
45+
uses: actions/checkout@v5
4646

4747
- name: Set up Python
4848
uses: actions/setup-python@v5
@@ -54,9 +54,6 @@ jobs:
5454
run: |
5555
pip install -r requirements.txt
5656
57-
- name: Install Jupyter Book (via myst)
58-
run: pip install jupyter-book
59-
6057
- name: Build HTML Assets
6158
run: |
6259
cd website
@@ -65,7 +62,7 @@ jobs:
6562
- name: Upload artifact
6663
uses: actions/upload-pages-artifact@v3
6764
with:
68-
path: './website/_build/site'
65+
path: './website/_build/html'
6966

7067
deploy:
7168
needs: build
@@ -81,4 +78,4 @@ jobs:
8178
steps:
8279
- name: Deploy to GitHub Pages
8380
id: deployment
84-
uses: actions/deploy-pages@v4
81+
uses: actions/deploy-pages@v5

‎website/data-deposit-aea.md‎

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
---
2-
title: Guidance on how to deposit data at the AEA Data and Code Repository
2+
title: Depositing at the AEA Data and Code Repository
33
toc: true
44
layout: single
55
date: 2021-09-06
66
modified: 2023-09-07
77
---
88

9-
### Tutorial
10-
11-
For a video tutorial on this process, see [this Youtube video](https://www.youtube.com/watch?v=wRytQcotLGc).
12-
13-
> If you are depositing at a different trusted repository, please be sure that your deposit complies with our [Display Guidelines for Trusted Repositories](guidelines-other-repositories)
14-
15-
16-
### Assistance
17-
18-
If, in the process of uploading your replication package, you have questions that are not addressed by these guidelines, please contact us:
19-
20-
- We are on [BlueSky](https://bsky.app/profile/aeadata.bsky.social), [Mastodon](https://mstdn.social/@aeadata/).
21-
- Contact us via the AEA's [Contact form](https://www.aeaweb.org/contact)
22-
- Reach out to the editor handling your paper, who knows how to reach us (but might also have the answer).
23-
- Reach out to us directly (you know how to find us).
24-
25-
In some cases, the [openICPSR helpdesk](https://www.openicpsr.org/openicpsr/contactUs) may be able to help you, but with any content matter, please contact us, not them.
269

2710
### Start the deposit process
2811

‎website/favicon.ico‎

4.19 KB
Binary file not shown.

‎website/index.md‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,55 @@
11
---
2-
title: Start replication package
2+
title: Guidance by the AEA Data Editor
3+
site:
4+
hide_outline: true
5+
hide_toc: true
6+
hide_title_block: true
7+
hide_next_steps: true
38
---
49

5-
<meta http-equiv="refresh" content="0; url=https://aeadataeditor.github.io/aea-de-guidance/">
10+
11+
+++ { "class": "col-body-outset" }
12+
13+
14+
15+
The following steps outline what you should expect after conditional acceptance of your manuscript, in compliance with the [AEA Data and Code Availability Policy](https://www.aeaweb.org/journals/policies/data-code). Note that the AEA's Data and Code Availability Policy is compatible with ![Link to DCAS Icon](https://datacodestandard.org/assets/img/DCAS-1.0.png) the [Data and Code Availability Standard](https://datacodestandard.org/) v1.0.
16+
17+
::::{grid} 1 1 2 3
18+
19+
:::{card}
20+
:link: /step-1
21+
**Prepare**
22+
^^^
23+
![1](/images/noun_One_2010363.png)
24+
25+
Prepare your data and code replication package (including data citations and provenance information). You can do this at any time, even before submitting to the AEA journals.
26+
27+
+++
28+
**Start** »
29+
:::
30+
31+
:::{card}
32+
:link: /step-2
33+
**Upload**
34+
^^^
35+
![2](/images/noun_two_2010370.png)
36+
37+
Provide metadata and upload the replication package. This step simultaneously prepares the materials for the verification process as well as for subsequent publication.
38+
39+
+++
40+
**Start to upload** »
41+
:::
42+
43+
:::{card}
44+
:link: https://www.aeaweb.org/journals/
45+
**Submit**
46+
^^^
47+
![3](/images/noun_three_2010367.png)
48+
49+
Submit the Data and Code Availability Form together with your manuscript native files as instructed, and as per guidelines at your journal (for example, AER guidelines). Only once these materials have been received by the editorial office are verification checks started.
50+
51+
+++
52+
**Ready to submit** »
53+
:::
54+
55+
::::

‎website/myst.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ project:
1313
# Auto-generated by `myst init --write-toc`
1414
- file: index.md
1515
- title: Step 1 - Prepare
16+
file: step-1.md
1617
children:
1718
- file: preparing-for-data-deposit.md
1819
- file: sharing-restricted-data.md
@@ -21,6 +22,7 @@ project:
2122
- file: guidelines-other-repositories.md
2223
#- file: addtl-data-citation-guidance.md
2324
- title: Step 2 - Upload
25+
file: step-2.md
2426
children:
2527
- file: data-deposit-aea.md
2628
- file: sharing-openicpsr.md
@@ -61,7 +63,9 @@ project:
6163

6264

6365
site:
64-
logo: images/office-aea-de.png
66+
options:
67+
logo: images/logo-aea.jpg
68+
# favicon: images/logo-aea-88x88.jpg
6569
#twitter: aeadata
6670
#template: book-theme
6771
#options:

‎website/preparing-for-data-deposit.md‎

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,8 @@
11
---
2-
title: Preparing your files for verification
2+
title: Preparing your files for verification - details
33
toc: true
4-
date: 2021-04-08
5-
modified: 2023-09-07
64
---
75

8-
This document describes how to best **prepare a replication package** for an AEA journal. Much of the guidance here
9-
is not specific to our journals - the document links to other websites for tutorials, best practices, etc. The best moment to do the preparation described here is, in fact, when you start the project, not once you have had your manuscript conditionally accepted. However, all steps here can and have been successfully performed at the point of conditional acceptance.
10-
11-
> ![Link to DCAS Icon](https://datacodestandard.org/assets/img/DCAS-1.0.png)
12-
The Data Editor of the American Economic Association endorses DCAS,
13-
the [Data and Code Availability Standard v1.0](https://datacodestandard.org/). The AEA's data and code availability policy is
14-
compatible with DCAS.
15-
16-
### Assistance
17-
18-
If, in the process of preparing your replication package, you have questions that are not addressed by these guidelines, please contact us:
19-
20-
- We are on [BlueSky](https://bsky.app/profile/aeadata.bsky.social), [Mastodon](https://mstdn.social/@aeadata/).
21-
- Contact us via the AEA's [Contact form](https://www.aeaweb.org/contact)
22-
- Reach out to the editor handling your paper, who knows how to reach us (but might also have the answer).
23-
- Reach out to us directly (you know how to find us).
24-
25-
### Key principle: Computational empathy
26-
27-
> - Keep in mind: The replication package is meant to be run by others, who have none of the setup, packages, and data that the original author might have, on computers that may not run the same operating system.
28-
> - Treat the replication package as one of the methods to convey the methods that lead to your manuscript's conclusions. Consider it a teaching tool, targeting young graduate students who may not be in your field.
29-
30-
316
### Describing the contents of your replication package with a README
327

338
Every replication package requires a document outlining where the data comes from, what data is provided, what requirements are needed to run the code in the replication package, how to run the code, what results to expect, and where to find the results. This is conventionally called the "README".

‎website/preparing-replication-package-details.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Preparing your code for computational verification: Details
2+
title: "Preparing your code for computational verification: Details"
33
toc: true
44
date: 2026-01-07
55
---

‎website/public/favicon.ico‎

4.19 KB
Binary file not shown.

‎website/step-1.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Preparing your files for verification
3+
toc: true
4+
---
5+
6+
This document describes how to best **prepare a replication package** for an AEA journal. Much of the guidance here
7+
is not specific to our journals - the document links to other websites for tutorials, best practices, etc. The best moment to do the preparation described here is, in fact, when you start the project, not once you have had your manuscript conditionally accepted. However, all steps here can and have been successfully performed at the point of conditional acceptance.
8+
9+
> ![Link to DCAS Icon](https://datacodestandard.org/assets/img/DCAS-1.0.png)
10+
The Data Editor of the American Economic Association endorses DCAS,
11+
the [Data and Code Availability Standard v1.0](https://datacodestandard.org/). The AEA's data and code availability policy is
12+
compatible with DCAS.
13+
14+
### Assistance
15+
16+
If, in the process of preparing your replication package, you have questions that are not addressed by these guidelines, please contact us:
17+
18+
- We are on [BlueSky](https://bsky.app/profile/aeadata.bsky.social), [Mastodon](https://mstdn.social/@aeadata/).
19+
- Contact us via the AEA's [Contact form](https://www.aeaweb.org/contact)
20+
- Reach out to the editor handling your paper, who knows how to reach us (but might also have the answer).
21+
- Reach out to us directly (you know how to find us).
22+
23+
### Key principle: Computational empathy
24+
25+
> - Keep in mind: The replication package is meant to be run by others, who have none of the setup, packages, and data that the original author might have, on computers that may not run the same operating system.
26+
> - Treat the replication package as one of the methods to convey the methods that lead to your manuscript's conclusions. Consider it a teaching tool, targeting young graduate students who may not be in your field.
27+

‎website/step-2.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Guidance on how to deposit data at the AEA Data and Code Repository
3+
toc: true
4+
layout: single
5+
date: 2021-09-06
6+
modified: 2023-09-07
7+
---
8+
9+
### Tutorial
10+
11+
For a video tutorial on this process, see [this Youtube video](https://www.youtube.com/watch?v=wRytQcotLGc).
12+
13+
> If you are depositing at a different trusted repository, please be sure that your deposit complies with our [Display Guidelines for Trusted Repositories](guidelines-other-repositories)
14+
15+
16+
### Assistance
17+
18+
If, in the process of uploading your replication package, you have questions that are not addressed by these guidelines, please contact us:
19+
20+
- We are on [BlueSky](https://bsky.app/profile/aeadata.bsky.social), [Mastodon](https://mstdn.social/@aeadata/).
21+
- Contact us via the AEA's [Contact form](https://www.aeaweb.org/contact)
22+
- Reach out to the editor handling your paper, who knows how to reach us (but might also have the answer).
23+
- Reach out to us directly (you know how to find us).
24+
25+
In some cases, the [openICPSR helpdesk](https://www.openicpsr.org/openicpsr/contactUs) may be able to help you, but with any content matter, please contact us, not them.

0 commit comments

Comments
 (0)