Skip to content

1036: Share a model #1055

Draft
chrisb13 wants to merge 4 commits intodevelopmentfrom
1036-cbull-communitywflows
Draft

1036: Share a model #1055
chrisb13 wants to merge 4 commits intodevelopmentfrom
1036-cbull-communitywflows

Conversation

@chrisb13
Copy link
Contributor

@chrisb13 chrisb13 commented Nov 4, 2025

I've now started a PR covering:

  • Hosting experiment repository on Github: a workflow for users for publications.
  • Explainer: Workflows for users who wish to share or develop experiments and configurations

Can you please look over the instructions, try them out and flesh them out where things are missing.

If you'd like to see some examples of what the journals require and what's done, see comments here.

Additional. I think it would be good to provide a template README with guidance on how they should be acknowledge us, what's needed to re-run the experiment. Similarly, if people are sharing intake experiments then they might be accessible with a link / metadata etc.

@Whyborn, when writing, I realised that it was clearer to explain the thinking behind the different strategies. This will be relevant to your PR so perhaps this content is better elsewhere, see docs/models/share_model/dev_model.md

Related:


Rendered versions available here:

  1. https://docs.access-hive.org.au/pr-previews/1055/models/share_model/publish_model
  2. https://docs.access-hive.org.au/pr-previews/1055/models/share_model/dev_model

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

PR Preview
🚀 Preview of PR head commit 53022b4 deployed to https://docs.access-hive.org.au/pr-previews/1055
2026-02-20 10:53 AEDT
Preview generated through the Deploy to GitHub Pages workflow run 22205172460.

@chrisb13
Copy link
Contributor Author

chrisb13 commented Nov 4, 2025

@atteggiani can you help with finding how to see the PR-preview of the two pages I've just added, namely

  1. ACCESS-Hive-Docs/docs/models/share_model/dev_model.md
  2. ACCESS-Hive-Docs/docs/models/share_model/publish_model.md

I was hoping they would appear here:

  1. https://docs.access-hive.org.au/pr-previews/1055/models/share_model/publish_model.md
  2. https://docs.access-hive.org.au/pr-previews/1055/models/share_model/dev_model.md
    but it hasn't worked. Can you please add the needed stuff to make that work? Or maybe I've got the links wrong?

For the moment, I've been imagining a new section under
https://docs.access-hive.org.au/models/
with "Share a model" (under run a model)

As such, the navigation/final home doesn't matter for the moment, what's more important is that @paigem and I arrive at content. We can shuffle it around once that's settled.


Update, thanks @atteggiani these now work:

  1. https://docs.access-hive.org.au/pr-previews/1055/models/share_model/publish_model
  2. https://docs.access-hive.org.au/pr-previews/1055/models/share_model/dev_model

@atteggiani
Copy link
Contributor

atteggiani commented Nov 4, 2025

@chrisb13
The pages should be added to the navigation (mkdocs.yaml's nav section)
Also, the links don't need the markdown extension (.md): https://docs.access-hive.org.au/pr-previews/1055/models/share_model/publish_model

@chrisb13
Copy link
Contributor Author

@paigem / @KAUR1984 any sense of when you'll have a chance to look at this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments