TechDoc changes for new metadata format (target gmtb/develop)#214
Conversation
…rmat (.meta XML file). Note that while the changes to the files committed here are complete, changes are still needed in other files. Those are in progress.
|
@JulieSchramm please look at this PR and provide feedback |
gold2718
left a comment
gold2718
left a comment
There was a problem hiding this comment.
A few corrections, comments, suggestions, and a question.
| dimensions = | ||
| type = | ||
| kind = | ||
| intent = |
There was a problem hiding this comment.
You might want to mention that the intent argument is only allowed in scheme metadata tables (they do not make sense and are not allowed in the other types).
There was a problem hiding this comment.
Good point, I will add this.
JulieSchramm
left a comment
JulieSchramm
left a comment
There was a problem hiding this comment.
Looks good pending Steve's and Julie's comments. Did 'make html' and 'make latexpdf' produce acceptable output files?
Yes. HOWEVER, we need to decide how to go about the PDF. At the moment, the title page contains mention to "release v3.0.0" and the date. For ease of updating the documentation, would it be reasonable for me to remove mention to release number and date? We just assume the documentation matches the HEAD of the GMTB repositories? Any better idea? |
|
Regarding the PDF: For the tagged release of version 3.0.0, all is good. Moving forward, as Ligia would say, lines 27, 29, and 143 of the CCPPtechnical/source/conf.py file should be modified to replace the version number with something else, maybe just whitespace or something else, until the next release. The PDF file will have a date stamp on the cover page to denote when it was created. |
…duced does not refer to a specific release number.
|
All changes needed to update the documentation to reflect the new metadata format are now in this PR, except for updates to how to process the new metadata with metadata2html.py before running Doxygen (Ligia work in progress).
Once the |
JulieSchramm
left a comment
JulieSchramm
left a comment
There was a problem hiding this comment.
Approved pending minor formatting changes.
… metadata tables in HTML format that are used for inclusion in the Scientific Documentation. Also, changes in the TechDoc to update the instructions to generate the Scientific Documentation using the new metadata format.
ligiabernardet
left a comment
ligiabernardet
left a comment
There was a problem hiding this comment.
All changes necessary to bring the documentation up to date with the code in gmtb/develop have been made and are ready for final review and merge.
|
Dom, Steve is on leave for a while, so you may need to override or ask
someone else to review.
…On Thu, Sep 5, 2019 at 9:02 AM mzhangw ***@***.***> wrote:
***@***.**** approved this pull request.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#214?email_source=notifications&email_token=AE7WQAQOXIETAO5QFYD5YI3QIENORA5CNFSM4IOJKD5KYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCDZJBAY#pullrequestreview-284332163>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE7WQATH6DV5MNT4SG4BHCDQIENORANCNFSM4IOJKD5A>
.
|
6 participants
This PR contains partial changes to update the documentation to reflect the new metadata format. Note that while the changes to the files proposed here are complete, changes are still needed
in other files. Those are in progress. Feedback on this PR is needed before work can proceed.