ACCESS-NRI / access-hive.org.au

Documentation hub for the Earth System models, ACCESS, and their community
https://access-hive.org.au/
8 stars 11 forks source link

Separate spaces for official and community docs #14

Closed aidanheerdegen closed 2 years ago

aidanheerdegen commented 2 years ago

The story:

As a user I want a clear distinction between documentation provided and supported by ACCESS-NRI, and documentation that is provided by the community.

As a member of the ACCESS-NRI I want it to be clear what documentation is supported by the NRI, so the community know where they can go if they have problems with NRI provided documentation.

A possible solution:

The PR preview feature shows that it is possible for two separate mkdocs sites to exist in their own subdirectory. This may be a solution to this issue: build and deploy the main branch to https://access-nri-community.github.io/ACCESSHub/Community and have another branch, access-nri, that deploys to https://access-nri-community.github.io/ACCESSHub/ACCESS-NRI.

Add some protection rules to the access-nri branch and that is a relatively simple solution. The access-nri branch can have different theme to differentiate it, and modified CI so that it deploys to the correct location.

aidanheerdegen commented 2 years ago

Pros for a separate branch and effectively separate mkdocs "sub-sites"

Cons

As one of the reasons to separate them is navigation, it is worth taking a bit of time to figure out what navigation would be desirable

Some possibilities:

NRI

- Releases:
    - ACCESS-OM
    - ACCESS-AM
    - ACCESS-ESM
    - ACCESS-CM
- Model Components:
    - Land
    - Ocean
    - Ice
    - Atmosphere
    - Coupler
- Documentation and Training:
    - Technical
    - Analysis
    - Data
    - Policies
- Model Evaluation:
    - Tools
    - Tutorials
    - Background information
- Working Groups:
    - Ocean-Sea Ice (COSIMA)
    - Atmosphere
    - Coupled Models
    - Land
    - Technical
    - Next Generation Methods
- Community (link back to Community site)

Community

- Modelling:
    - Ocean/Sea-Ice
    - ACCESS Coupled
    - ACCESS Seasonal
    - Land
    - Regional Atmosphere
    - Regional Ocean
    - Biogeochemistry
- Evaluation and Analysis:
   - CMIP
   - Land
   - Ocean Sea-ice
   - Atmosphere
   - Machine Learning
   - General
- Training resources:
   - General technical
   - Modelling
   - Analysis
- ACCESS-NRI Documentation
ccarouge commented 2 years ago

We decided to go with the main site pointing to the Community Hub and the ACCESS-NRI as a sub-site following the latest version presented in #37