Add github pages deploy guide #27
Conversation
|
|
||
| - https://ome.github.io/ome2024-ngff-challenge/ from https://github.com/ome/ome-ngff-validator/tree/gh-pages | ||
| - https://ome.github.io/ome-ngff-validator/ from https://github.com/ome/ome2024-ngff-challenge/tree/gh-pages | ||
| - https://will-moore.github.io/figure/ from https://github.com/will-moore/figure/tree/gh-pages |
There was a problem hiding this comment.
This should be moved. It will be preferable not to use a personal account to publish pages
There was a problem hiding this comment.
Those certainly will be moved in due course (PRs are open) and are not "public". But I didn't want to use broken links (or to miss them out from this doc).
There was a problem hiding this comment.
If it's just for examples, we can choose to use the ones here that are most likely to stick around. If you want something of a registry, we could agree on a tag (ome-pages?) so we could find them all in one go.
There was a problem hiding this comment.
I would like to think that those examples would be around for a while. We could hold off on this PR until the PRs for those branches are merged (might be a while, but I guess this isn't urgent). Or I could remove the links. I know where to find the examples anyway.
There was a problem hiding this comment.
Since this is a docs page with links that are meant to be useful as a reference (rather than links that are actually live/merged/public pages) I would prefer to keep these links for now. They are likely to be valid for the foreseeable future.
There was a problem hiding this comment.
Note that https://will-moore.github.io/figure/ is now 404. Since this PR is now approaching a year old, is there a plan to address the requested changes? Or does this require enough further discussion that it makes sense to either turn into a draft or close for now?
There was a problem hiding this comment.
Thanks for that. It should be https://will-moore.github.io/omero-figure/
I'm still using this PR as a useful doc for gh pages, I don't know if anyone else has needed it.
I won't have time to review it much this week. Happy for it to be turn it into a draft until I do find time (maybe the next time I use it).
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
Co-authored-by: jean-marie burel <j.burel@dundee.ac.uk>
|
Should this be be unified with https://ome-contributing.readthedocs.io/en/latest/jekyll.html to cover all OME (& IDR?) repositories using GitHub Pages as a deployment mechanism, whether it's using Jekyll or something else as a build system? |
|
Generally, 👍 for having the steps. As @will-moore says, he and I have struggled 2-3 times (at least) to get these npm-based sites set up. |
|
@sbesson I see that both pages mention gh-pages, but that page seems more directed towards "How to use the existing Jekyll setup we have for the main ome website" rather than "How to create build steps and GHA for new deployments". In reading the 2 pages there's not very much overlap and I think combining them into one page could make it more confusing? |
|
No objection from my side if you guys feel the content is different enough that it's worth separating and maintaining across 2 separate pages |
As suggested by @joshmoore on previous occasions, setting up
gh-pagesdeployment from an app can be a pain.Hopefully this guide will make it easier in future.