Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Page on How-To Prerelease #851

Merged
merged 8 commits into from
Jan 30, 2025
Merged

Add Page on How-To Prerelease #851

merged 8 commits into from
Jan 30, 2025

Conversation

CodeGat
Copy link
Member

@CodeGat CodeGat commented Dec 5, 2024 •
edited by atteggiani
Loading

ACCESS-Hive Docs

Description

Adds a page under Run A Model regarding how to create Prerelease Model Deployments via the Pull Request process in Model Deployment Repositories. This work is based on https://github.com/ACCESS-NRI/model-deployment-template/blob/80117aaad00cdff0cab70e567790e73a183a9267/CONTRIBUTING.md.

Fixes #843
Fixes ACCESS-NRI/build-cd#163
Fixes #809

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue, e.g. dead links)
  • New link / content

Checklist:

  • The new content is accessible and located in the appropriate section
  • My changes do not break navigation and do not generate new warnings
  • I have checked that the links are valid and point to the intended content
  • I have checked my code/text and corrected any misspellings
  • I have chosen the correct tag for the level of support provided

@CodeGat CodeGat added the ✏️ documentation Improvements or additions to documentation label Dec 5, 2024
@CodeGat CodeGat self-assigned this Dec 5, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 5, 2024 •
edited
Loading

PR preview
🛬 Preview link removed because the pull request was closed.

@CodeGat CodeGat mentioned this pull request Jan 1, 2025
Merged
@CodeGat CodeGat force-pushed the 843-how-to-prerelease branch 2 times, most recently from 4bb7633 to 621f13a Compare January 14, 2025 04:56
@CodeGat
Copy link
Member Author

CodeGat commented Jan 14, 2025

Interesting - using GitHubs own Update and Rebase option leads to unverified commits!

@atteggiani atteggiani self-requested a review January 14, 2025 05:39
@atteggiani
Copy link
Contributor

Interesting - using GitHubs own Update and Rebase option leads to unverified commits!

Yeah, apparently there is no way around that (other than not using it from the Web Interface)
It's a bummer.

@CodeGat CodeGat force-pushed the 843-how-to-prerelease branch from 078ea4d to b821060 Compare January 15, 2025 03:20
@CodeGat
Copy link
Member Author

CodeGat commented Jan 15, 2025

@atteggiani I've just rebased so my commits are verified so merging works eventually 😆

atteggiani
atteggiani requested changes Jan 19, 2025
View reviewed changes
docs/assets/model/Pr_Process.svg Outdated Show resolved Hide resolved
docs/models/run-a-model/create-a-prerelease.md Outdated Show resolved Hide resolved
@atteggiani atteggiani force-pushed the 843-how-to-prerelease branch 2 times, most recently from d76033a to 222d578 Compare January 20, 2025 01:05
CodeGat
CodeGat commented Jan 20, 2025
View reviewed changes
Copy link
Member Author

@CodeGat CodeGat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it looks good for an approval!

@atteggiani atteggiani self-requested a review January 20, 2025 01:07
@atteggiani atteggiani requested a review from heidinett January 20, 2025 01:08
@CodeGat
Copy link
Member Author

CodeGat commented Jan 20, 2025

There seems to be an error: #851 (comment)

heidinett
heidinett reviewed Jan 30, 2025
View reviewed changes
mkdocs.yml Outdated Show resolved Hide resolved
heidinett
heidinett reviewed Jan 30, 2025
View reviewed changes
Copy link
Contributor

@heidinett heidinett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @atteggiani. I have made some suggestions that I think improve the readability. Feel free to adopt or ignore.
I also noticed that in the blue warning box at the top of the page, which also appears at the top of other run-a-model pages, that there is inconsistent use of the word "code-block" / "code block". I would go with "code block" as two separate words.

@atteggiani atteggiani mentioned this pull request Jan 30, 2025
Closed
@atteggiani atteggiani force-pushed the 843-how-to-prerelease branch from 7c08f5e to 8056e49 Compare January 30, 2025 23:16
@atteggiani atteggiani merged commit 25c134f into development Jan 30, 2025
5 of 7 checks passed
@atteggiani
Copy link
Contributor

Thank you for the precious review @heidinett!
Most of your suggestions were added in!

And thank you to @CodeGat for starting this PR and reviewing the changes.

Merged.

@atteggiani atteggiani deleted the 843-how-to-prerelease branch January 30, 2025 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@atteggiani atteggiani atteggiani approved these changes

@heidinett heidinett heidinett left review comments

Assignees

@CodeGat CodeGat

Labels
✏️ documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
3 participants
@CodeGat @atteggiani @heidinett