Resolve "Update authorship and title of Ocean Engine for 4.2.1 release"

Closes #5 (closed)

-Use current NEMO System Team members as authors (seems most fair way to proceed)

-Update title to 4.2.1 Manual (not "Version main" as is stated now).

added 1 commit

• 0abe9582 - update author list to 2023 NST

Compare with previous version

@khutchinson actually the manual version is picked up by the name of the branch/tag, so once we define the tag 4.2.1 of the manual this will be the name associated to the Version in the title. No need to change anything.

Besides, you last changes broke the latex so I'll take care of fixing it (red mark on the commit pipeline).

added 1 commit

• f5800687 - fix typos in author list and add orcid info

Compare with previous version

changed the description

Hi @tlovato,

Thanks so much for fixing the text for me I am learning how this all works and so have some questions so that I can be better next time:

• When you said in your message that "we need to ensure that the latex is, at least, always producing the manuals pdf" do you mean that we cannot/should not ever push commits back to our branches that break our own pipeline and thus do not produce a pdf? In other words, we should not save "drafts" of our work back on the forge as this will break the pipeline...?

• I struggled to get the pdf to compile on my local machine even though I have installed the latex and pygments packages. I got lot's of notices that I am missing input files (e.g. Latexmk: Missing input file 'NEMO_manual.toc'). Have I made a mistake when cloning the submodules? Can you send me instructions to follow to do the local build?

• Out of interest, did you have to look up the ORCHIDs for each author or is there a reference file that is updated for this?

Lastly: are we happy with this version of the documentation? If so could you generate a pdf with r4.2.1 as the title and I will add it to the zenodo repository.

Thanks so much! K

The pipeline is always on, especially because is rather inexpensive and artefacts (namely the PDFs) are store only for 15 mins. So one can always have and immediate feedback on the changes.

Did you followed the instructions on the README file? Maybe a feedback to improve it where lacking would be useful. Besides, when compiling on my local I get a lot of warnings as well (especially now that I moved to TEX2023), but so far it works fine.

For the ORCIDs I went one by one looking on the internet. Maybe we can send an email around as for many people I was not able to find it.

For the final version when we decide it is ok, we create the 4.2.1 tag and from there anyone can create the PDF by re-running the manuals pipeline manually from the CI/CD menu.

Hello again,

We created the 4.2.1 tag in the nemo project last week so the code tag ready: https://forge.nemo-ocean.eu/nemo/nemo/-/releases/4.2.1

I plan on announcing next week and would like to update the Zenodo ref manual link before then. So do we need to create a separate tag in the Documentation/Ref manuals project to get the name 4.2.1 on the pdf?

K

If the list of authors is ok, we can proceed with the merge of this update and then move forward with the creation of the tag for the manuals.

added 1 commit

• d1124feb - Addition of some ORCHID ids

Compare with previous version

marked this merge request as ready

added 4 commits

• d1124feb...c496a6ba - 2 commits from branch main
• 684869d6 - Merge branch 'main' into 5-update-authorship-and-title-of-ocean-engine-for-4-2-1-release
• 1f39501b - udpdate gallery and namelists submodules

Compare with previous version

added 1 commit

• 332d3b7c - update zenodo badges in NEMO and SI3 manuals

Compare with previous version

mentioned in issue #5 (closed)

added 1 commit

• 21373b6c - update author list v2

Compare with previous version

@khutchinson I will complete this MR and move forward with the tag creation

merged

mentioned in commit a7def739