Skip to content

Commit 11fba61

Browse files
eduardo-rodriguesgraeme-a-stewart
authored andcommittedNov 6, 2018
Updates to TN page - explanations on how to mint a DOI to TNs (#399)
1 parent e2208eb commit 11fba61

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed
 

‎technical_notes.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,41 @@ layout: default
66

77
# Technical Notes
88

9-
The HEP Software Foundation technical note series was created to provide a curated, archival home for documents arising from or relevant to the activities of the HSF and related projects. All suggestions for including documents in the series are welcome. Please contact the current technical notes series editor (Andrew McNab) for help in submitting notes or to discuss whether they are within the scope of the series.
9+
The HEP Software Foundation technical note series was created to provide a curated, archival home for documents arising from or relevant to the activities of the HSF and related projects. All suggestions for including documents in the series are welcome. Please contact the current technical notes (TNs) series editor (Andrew McNab) for help in submitting notes or to discuss whether they are within the scope of the series.
1010

11-
Notes should be referenced in other publications as _Author(s), HSF-TN-YYYY-NN "The Title" (HEP Software Foundation)_ rather than with a URL.
11+
Notes should be referenced in other publications as _Author(s), "The Title", HSF-TN-YYYY-NN, Zenodo, DOI link_ rather than with a URL.
12+
Example citations can be found on either the GitHub or DOI links in the table of TNs below.
1213

13-
The Technical Notes policy is set out in the first technical note. Finalized notes and some of the later stages of the acceptance process are stored in the HSF GitHub repository. Final PDF files are copied to the main hepsoftwarefoundation.org website.
14+
The Technical Notes policy is set out in the first technical note. Finalized notes and some of the later stages of the acceptance process are stored in the HSF [GitHub repository](https://github.com/HSF/documents/tree/master/HSF-TN).
15+
Final PDF files are copied to the main hepsoftwarefoundation.org website.
1416

1517
{:.table .table-hover .table-condensed .table-striped}
1618
| TN Number | Title | Authors | Download |
1719
| ------------- | ------------- | ------------ |---------------|
18-
| HSF-TN-2018-01 | HSF Platform Naming Conventions | B. Hegner | [PDF](/notes/HSF-TN-2018-01.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2018-01) [DOI](http://doi.org/10.5281/zenodo.1472351) |
20+
| HSF-TN-2018-01 | HSF Platform Naming Conventions | B. Hegner | [PDF](/notes/HSF-TN-2018-01.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2018-01) |
1921
| HSF-TN-2016-04 | Vacuum Platform | A. McNab | [PDF](/notes/HSF-TN-2016-04.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2016-04) [DOI](http://doi.org/10.5281/zenodo.1469634) |
20-
| HSF-TN-2016-03 | HSF Packaging Working Group Report | L. Sexton-Kennedy, B. Hegner, B. Viren | [PDF](/notes/HSF-TN-2016-03.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2016-03) [DOI](http://doi.org/10.5281/zenodo.1472340) |
22+
| HSF-TN-2016-03 | HSF Packaging Working Group Report | B. Hegner, L. Sexton-Kennedy | [PDF](/notes/HSF-TN-2016-03.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2016-03) |
2123
| HSF-TN-2016-02 | Machine/Job Features | M. Alef et al.| [PDF](/notes/HSF-TN-2016-02.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2016-02) [DOI](http://doi.org/10.5281/zenodo.1469629) |
2224
| HSF-TN-2016-01 | Software Licence Agreements HSF Policy Guidelines | J. Harvey et al. | [PDF](/notes/HSF-TN-2016-01.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2016-01) [DOI](http://doi.org/10.5281/zenodo.1469636) |
2325
| HSF-TN-2015-01 | HSF Technical Notes policy | A. McNab | [PDF](/notes/HSF-TN-2015-01.pdf) [GitHub](https://github.com/HSF/documents/tree/master/HSF-TN/2015-01) [DOI](http://doi.org/10.5281/zenodo.1469623) |
2426

27+
### How to obtain a DOI for publication
28+
29+
Once the TN is finalized and you are ready to submit all documents to the GitHub repository, please follow these instructions to obtain a DOI on Zenodo:
30+
31+
1) Go to Upload then New Upload on the Zenodo website..
32+
2) Click on the Reserve DOI javascript button under DOI (and keep the form page loaded!).
33+
3) Copy and paste the reserved DOI into the .tex file from the Git repo.
34+
4) Rebuild PDF.
35+
5) Upload to Zenodo as normal on the same form page as the reserved DOI.
36+
6) Push to GitHub.
37+
38+
It is a good idea to also add a README file with information on how to cite the note, see the examples under links such as
39+
(this one)[https://github.com/HSF/documents/blob/master/HSF-TN/2015-01/README.md].
40+
2541
## Drafts in the consultation stage
2642

27-
Before being assigned an HSF reference and being archived in their final form, final drafts are published on the [hsf-forum](http://groups.google.com/d/forum/hsf-forum) mailing list by the technical notes series editor. In most cases, this consultation stage is intended to cover the formatting and language quality of the notes, rather than the substantive content which has already been decided by the relevant HSF activity or external project.
43+
Before being assigned an HSF reference and being archived in their final form, final drafts are published on the [hsf-forum](http://groups.google.com/d/forum/hsf-forum) mailing list by the TNs series editor. In most cases, this consultation stage is intended to cover the formatting and language quality of the notes, rather than the substantive content which has already been decided by the relevant HSF activity or external project.
2844

2945
{:.table .table-hover .table-condensed .table-striped}
3046
| Draft TN Reference | Title | Authors | Ends | Download |

0 commit comments

Comments
 (0)
Please sign in to comment.