Content duplication creating maintenance burden?

[chrisb13]

We've noticed that much of the content in here is also in the ACCESS Hive docs here. This then gets propagated to places like:

• https://github.com/accESS-NRI/access-om2
• https://github.com/accESS-NRI/access-om3
• https://github.com/accESS-NRI/access-ram
• https://github.com/accESS-NRI/access-esm1.5
• etc

I'm just wondering if this creates a maintenance burden when these changes become out of date or need to be updated? In general, I'm in favour of having as few sources of documentation as possible. So could we not just link to the hive docs in this case?

This came up because we're in the process of creating config' docs where we are intending to house model specific guidance on these kinds of issues.

Ping'ing @CodeGat @jo-basevi @anton-seaice @atteggiani who might have thoughts?

[atteggiani]

I agree on reducing documentation burden and trying to keep one documentation up to date, while linking to it in all other places.

In this case, the GitHub version of the documentation was the one written by Tommy (I suppose) at the beginning, off which the Hive Docs page was based.
Therefore, I think there should be no problems linking directly the Hive Docs page in the instances where that content is needed, rather than linking the GitHub version.

[aidanheerdegen]

Agreed. Does anyone want to make a PR for this?

[anton-seaice]

I am not totally convinced access-hive-docs is the right place.

We are very limited in who we give write access to outside access-nri, so this seems like more of an internal/developer instruction than one which belongs on the website (which seems more for user instructions)?

[atteggiani]

Those instructions are already in the Hive Docs website.
Something that could be done, if needed, is adding a few pieces of information from the GitHub content to the Hive Docs one.
But the core concepts are all present already.

[anton-seaice]

We (@aidanheerdegen @chrisb13 @CodeGat @dougiesquire etc) agreed today to double check the github content is all included in the hive docs, and then remove Contributions.md from this repo and all the contributions repos (and link to the access-hive docs in the Readme's instead).

@CodeGat - can you implement this please ? :)

[CodeGat]

Can do :)