diff --git a/doc/developers/developers.rst b/doc/developers/developers.rst new file mode 100644 index 00000000..c0f28ae5 --- /dev/null +++ b/doc/developers/developers.rst @@ -0,0 +1,11 @@ +.. _developers: + +For Developers +=============== + +.. toctree:: + :maxdepth: 2 + :numbered: + + filenaming.rst + user_emails.rst diff --git a/doc/developers/filenaming.rst b/doc/developers/filenaming.rst new file mode 100644 index 00000000..ebd58e2c --- /dev/null +++ b/doc/developers/filenaming.rst @@ -0,0 +1,18 @@ +.. _filenaming: + +Naming of input files used in NorESM +====== +All input data files need to have the version information included in the file name. We recommend to add the creation date at the end of +the file name on the format YYYYMMDD, where: + +| YYYY: year +| MM: month +| DD: day +| +| If the files are generated for NorESM specifically, we recommend to add an **n** before the creation date: + +:: + + $FILENAME_nYYYYMMDD + +:: diff --git a/doc/developers/user_emails.rst b/doc/developers/user_emails.rst new file mode 100644 index 00000000..beaad159 --- /dev/null +++ b/doc/developers/user_emails.rst @@ -0,0 +1,34 @@ +.. _user_emails: + +Answering emails from users +=================================== +Procedure for answering questions from external users through the noresm-ncc contact e-mail +^^^^^ +1. Any email to noresm-ncc (UNLESS, see below) will be made into a github issue (in the most relevant repository of NorESMHUB by a noresm-ncc responible, labelled in github “noresm-ncc-question”), and the issue will be assigned to noresm-ncc responsible per repository. +2. UNLESS the answer is straightforward with an email, this is sent with copy to noresm-ncc +3. Acknowledge by email the receipt of the inquiry - explaining further the standard procedure to “user”, including link to github issue, with copy to noresm-ncc +4. Standard procedure: Answering will be done on github +5. Standard procedure: Please check the issue status, and comment further by signing in, sign in if you want to follow the issue +6. Someone from NorESM (assignees) put replies into the github issue, discussion is kept there +7. If discussion is continuing by email, the assignee paste discussion into issue +8. Standard procedure: final reply(ies) will be through closing the issue and sending an email again by the “responsibles” that this issue is closed, with the link to the issue. Remind the user: You may reopen it. +9. What to do with continued discussion? Encourage users to follow the github issue + + +Template for answering emails from users +^^^^^ +Dear xxx, + +Thank you for your email regarding the NorESM2 data/model. + +Please note, that we have included your question in the appropriate NorESMhub github repository (name of repository) as #issue (link to issue). This is done because we thought that the issue could be of interest for other users, and because we are trying to assemble all NorESM2 relevant discussions and documentation under one open platform. + +What follows? The issue will be answered as soon as possible by a member of the NorESM2 core team via github. You can follow the (link to issue) on github. You may also get directly notified, when we answer, if you subscribe to the notifications (go to the issue, see for the right panel on github, press notifications button “subscribe”). + +Please note that we prefer to keep follow-up discussion on github, and invite you to further comment on the issue on github. You may also remind us of unresolved, urgent issues via github by adding another comment to the issue. + +Once we consider the issue resolved, you will also get an email. This is to notify you in case you didn't watch the github issue closely. + +| Best wishes +| Name +| for the NorESM2 core team diff --git a/doc/index.rst b/doc/index.rst index c831620b..0ac70f66 100755 --- a/doc/index.rst +++ b/doc/index.rst @@ -36,6 +36,7 @@ For obtaining news per email register to users@noresm.org at https://www.noresm. keyruns/keyruns.rst data/data.rst contribute/contribute.rst + developers/developers.rst faq/faq.rst