Skip to content

Commit f36f878

Browse files
committed
Playing around with reformatting website pages
1 parent 0cf5153 commit f36f878

5 files changed

Lines changed: 123 additions & 80 deletions

File tree

.DS_Store

6 KB
Binary file not shown.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# MyST build outputs
22
_build
33
.venv
4+
.html

website/data-deposit-aea.md

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,16 @@ In some cases, the [openICPSR helpdesk](https://www.openicpsr.org/openicpsr/cont
2929

3030
[![Start deposit](/images/icpsr-start-your-deposit-v2.png)](https://www.openicpsr.org/openicpsr/workspace?create=true&archive=aea)
3131

32-
33-
34-
Go to the [AEA Data and Code Repository](https://www.icpsr.umich.edu/sites/aea/home), and start the process.
32+
1. Go to the [AEA Data and Code Repository](https://www.icpsr.umich.edu/sites/aea/home), and start the process.
3533
Once there, click on the "Share Data" link:
3634

3735
[![Start process](/images/icpsr-start-process-share-data-v2.png)](https://www.icpsr.umich.edu/sites/aea/home)
3836

39-
You will be taken to a page explaining some of the technical details. Click on the "[Start Your deposit](https://www.openicpsr.org/openicpsr/workspace?create=true&archive=aea)" button to initiate the deposit process itself.
37+
2. You will be taken to a page explaining some of the technical details. Click on the "[Start Your deposit](https://www.openicpsr.org/openicpsr/workspace?create=true&archive=aea)" button to initiate the deposit process itself.
4038

4139

4240
---
43-
44-
### Checklist for Metadata
41+
````{dropdown} **Checklist for Metadata**
4542
4643
#### Required
4744
@@ -75,25 +72,23 @@ You will be taken to a page explaining some of the technical details. Click on t
7572
- [ ] Units of Observation
7673
- [ ] Any additional metadata elements
7774
78-
---
79-
8075
Start by providing the metadata (descriptors) for the data and code you are uploading.
8176
77+
````
8278

83-
### Details on Filling Out Metadata
79+
`````{dropdown}**Details on Filling Out Metadata**
8480
85-
86-
#### Describe the project
81+
````{dropdown} Describe the project
8782
8883
![screenshot of project description](/images/project-description-icpsr.png)
8984
9085
- The **title** should be "`Data and Code for: [Title of article]`" if it contains both data and code. If only one or the other are included, then "`Data for: [Title of article]`" or "`Code for: [Title of article]`". In some cases, when data is split across multiple deposits, one might use "`Supplementary Data for: [Title of article]`". Do not use the uninformative "Replication files for...", nor "Data for ..." when the deposit contains code.
9186
- The **authors** should be those who compiled the data and code. The names, and order of the names, may differ (if necessary) from the article.
9287
- The **summary** might be short. It should always be informative. It can include the **abstract** of the article itself. It should not include information on the related article (which has its own field). If data is included, the summary/abstract should describe the data.
9388
- Identify any **funding sources** here - the information can be queried by some funders, and can assist with your award reporting.
89+
````
9490
95-
96-
#### Scope of project section
91+
````{dropdown} Scope of project section
9792
9893
To fill out the required metadata elements **Subject Terms**, **JEL Classification**, and **Manuscript Number**, open the "Scope of Project" section:
9994
@@ -115,8 +110,9 @@ To fill out the required metadata elements **Subject Terms**, **JEL Classificati
115110
- Most fields are repeatable, please enter as many values as needed. For instance, if subsets of the data cover different periods (e.g., `1999-2019` and `2004-2019`). Just click "add value" next to the time period field for each time period.
116111
- This information can also be provided when only code is made available.
117112
- When only code is produced, authors should choose `data type = program source code`: ![program source code](/images/project-data-type-icpsr.png)
113+
````
118114
119-
#### Methodology section
115+
````{dropdown} Methodology section
120116
121117
![methodology section](/images/project-methodology-icpsr.png)
122118
@@ -133,17 +129,16 @@ To fill out the required metadata elements **Subject Terms**, **JEL Classificati
133129
- Authors are encouraged to link back to **working papers** or related publications that have or will use this (same!) data.
134130
- If code is derived from or continues to be updated on a Git repository (**Github, Gitlab, Bitbucket**, etc.), authors can link to it here.
135131
- Future functionality will automatically list articles (including articles by third parties) that cite the data.
132+
````
136133
134+
`````
137135

138-
139-
### Uploading
136+
````{dropdown}**Uploading**
140137
141138
Once the metadata is completed, authors can upload files.
142139
143140
Upload files in the way you expect the files to be organized in order to run the code.
144141
145-
---
146-
147142
#### Checklist for Uploading
148143
149144
- [ ] README is in PDF or TXT format
@@ -153,9 +148,9 @@ Upload files in the way you expect the files to be organized in order to run the
153148
- [ ] Do not upload data that you do not have the rights to publish! (This includes PII that is not authorized by your IRB)
154149
- [ ] Do not upload confidential data!
155150
156-
---
151+
````
157152

158-
### Some caveats and tips
153+
````{dropdown}**Some important caveats and tips**
159154
160155
#### Importing ZIP files
161156
@@ -197,40 +192,13 @@ We said it above:
197192
> - See the "[Depositing Data for the Greater Good](https://social-science-data-editors.github.io/guidance/sample-depositing-data-for-greater-good.html)" page at the Social Science Data Editors website.
198193
> - Consult the [Accessing Restricted Data Through openICPSR](https://www.openicpsr.org/openicpsr/accessRD) page about the process at openICPSR, but other repositories may be acceptable.
199194
200-
**TL;DR version:**
201-
202-
- [ ] Choose where to upload any restricted data (but not HERE)
203-
- [ ] If you are able to provide the data to the Data Editor, select the appropriate checkbox on the [DCAF](https://www.aeaweb.org/journals/forms/data-code-availability) but **DO NOT** upload the data here (even temporarily). You will be sent a secure upload form.
204-
- [ ] Be sure to answer the [Submission questions](#submission-questions) with respect to the data that you **have** deposited, not data withheld or deposited elsewhere
205-
- [ ] proceed as usual as outlined below
206-
207-
#### Tips
208-
209195
- Please upload the README (in PDF or TXT) as the very first file - ensuring that it can be found easily by browsers of the archive.
210196
- It is OK to upload Markdown or Word documents in addition to, but not instead of the PDF or TXT version
211197
- Please upload the README to the root of the repository - any data and code can be in subdirectories, but it is easier to find the README if it is not in subdirectories.
212198
- There should be no duplicate README files in the repository
199+
````
213200

214-
#### Ideal structure
215-
216-
Your deposit should have
217-
218-
- [ ] no redundant directories: the first thing you should see is the README and any subdirectories
219-
- [ ] there should be no ZIP files!
220-
- [ ] the structure should be as you last ran the code
221-
222-
> [NOTE] The AEA staff will not re-arrange or otherwise restructure your deposit in any way. What you see in the deposit interface is what others will see once it is published.
223-
224-
You should see something like this:
225-
```
226-
data_directory/
227-
prog_directory/
228-
README.pdf
229-
LICENSE.txt
230-
```
231-
(the `LICENSE.txt` is optional if you want to adopt one of the standard openICPSR licenses upon publication. See [our licensing guidance](Licensing_guidance) for other options).
232-
233-
### Submitting to the Data Editor
201+
````{dropdown}**Submitting to the Data Editor**
234202
235203
Once you are satisfied that all (publishable) data files are present, are complete, and all metadata is satisfactory, including all required elements filled out, you should **submit** the deposit, by changing the **status** of the deposit:
236204
@@ -274,9 +242,9 @@ You should choose a license from the drop-down menu, or, if you have a custom li
274242
#### Finalizing
275243
276244
Press "submit." Should you have forgotten something, you can "recall" the submission, fix the issue, and re-submit.
245+
````
277246

278-
279-
### Citing Your Deposit
247+
````{dropdown}**Citing Your Deposit**
280248
281249
At present (2020), the openICPSR repository does not display the Digital Object Identifier (DOI) that will be associated with your deposit. However, it can be deduced easily.
282250
@@ -301,7 +269,39 @@ At present (2020), the openICPSR repository does not display the Digital Object
301269
302270
{% include deposit-doi.html %}
303271
272+
````
273+
304274
### Ready to submit manuscript
305275

306276
Once you have completed the deposit, you are now ready to submit the manuscript native files, together with the [Data and Code Availability Form](https://www.aeaweb.org/journals/forms/data-code-availability), as per the journal's guidelines ([AER guidelines here](https://www.aeaweb.org/journals/aer/submissions/accepted-articles/styleguide)).
307277

278+
**TL;DR version:**
279+
280+
- [ ] Choose where to upload any restricted data (but not HERE)
281+
- [ ] If you are able to provide the data to the Data Editor, select the appropriate checkbox on the [DCAF](https://www.aeaweb.org/journals/forms/data-code-availability) but **DO NOT** upload the data here (even temporarily). You will be sent a secure upload form.
282+
- [ ] Be sure to answer the [Submission questions](#submission-questions) with respect to the data that you **have** deposited, not data withheld or deposited elsewhere
283+
- [ ] proceed as usual as outlined below
284+
285+
286+
#### Ideal structure
287+
288+
Your deposit should have
289+
290+
- [ ] no redundant directories: the first thing you should see is the README and any subdirectories
291+
- [ ] there should be no ZIP files!
292+
- [ ] the structure should be as you last ran the code
293+
294+
> [NOTE] The AEA staff will not re-arrange or otherwise restructure your deposit in any way. What you see in the deposit interface is what others will see once it is published.
295+
296+
You should see something like this:
297+
```
298+
data_directory/
299+
prog_directory/
300+
README.pdf
301+
LICENSE.txt
302+
```
303+
(the `LICENSE.txt` is optional if you want to adopt one of the standard openICPSR licenses upon publication. See [our licensing guidance](Licensing_guidance) for other options).
304+
305+
````
306+
307+

website/myst.yml

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,53 @@
22
version: 1
33
project:
44
id: b3aab372-57be-4d69-b406-05a368291584
5-
# title:
5+
# title:
66
# description:
77
# keywords: []
88
# authors: []
99
github: https://github.com/AEADataEditor/aea-de-guidance.v3
1010
# To autogenerate a Table of Contents, run "jupyter book init --write-toc"
11+
12+
toc:
13+
# Auto-generated by `myst init --write-toc`
14+
- file: index.md
15+
- file: preparing-for-data-deposit.md
16+
- file: addtl-data-citation-guidance.md
17+
- file: data-deposit-aea-guidance.md
18+
- file: data-deposit-aea.md
19+
- file: sharing-openicpsr.md
20+
- file: creating-datalumos-deposit.md
21+
- file: creating-restricted-data-deposit-icpsr.md
22+
- file: creating-restricted-data-deposit-icpsr-old.md
23+
- file: creating-separate-data-deposit.md
24+
- file: preparing-for-pandp.md
25+
- file: reproducibility-checks.md
26+
- file: sample-report.md
27+
- file: 2021-01-05-Answers-to-questions.md
28+
- file: disclaimer.md
29+
- file: _faq.md
30+
- file: faq.md
31+
- file: guidelines-other-repositories.md
32+
- file: LICENSE-template.md
33+
- file: Licensing_guidance.md
34+
- file: next.md
35+
- file: overview.md
36+
- file: preparing-replication-package-details.md
37+
- file: preparing-replication-package.md
38+
- file: protocol-3rd-party-replication.md
39+
- file: replication-comment.md
40+
- file: sample-language-report.md
41+
- file: sample-report-3rd-1.md
42+
- file: sharing-restricted-data.md
43+
- file: step-by-step.md
44+
- file: template_inquiry_about_DOI_by_editor.md
45+
- file: template-ipums-api-beta.md
46+
- file: third-party-request.md
47+
- file: using_codeocean.md
48+
1149
site:
1250
template: book-theme
1351
# options:
1452
# favicon: favicon.ico
1553
# logo: site_logo.png
54+

0 commit comments

Comments
 (0)