search

2i2c-org / hub-user-image-template

BSD 3-Clause "New" or "Revised" License
5 stars 14 forks source link

Link in README not working #31

Closed jbusecke closed 4 months ago

jbusecke commented 4 months ago

A researcher at LEAP just noticed that the link in the readme https://docs.2i2c.org/en/latest/admin/howto/environment/hub-user-image-template-guide.html is not working anymore. Does anyone here know what the correct replacement is?

yuvipanda commented 4 months ago

/cc @jnywong

jnywong commented 4 months ago

Hey @jbusecke, this has been replaced with https://docs.2i2c.org/admin/howto/environment/customize-image/.

I can setup a redirect from the old link to the new link 👍

jnywong commented 4 months ago

Hey I've applied the redirect but it works for https://docs.2i2c.org/en/latest/admin/howto/environment/hub-user-image-template-guide without the .html extension. Is that okay? If not I can look into it a bit more

jbusecke commented 4 months ago

Thanks for that @jnywong. Unfortunately this does not work with the current version of the README here. Unless this is referenced somewhere else in a different way, we might as well put the new link into the README (see #32)?

jnywong commented 4 months ago

Ah I see more clearly which README you are referencing.

@jbusecke can I get your input into whether we should deprecate the latter hub-user-image-template-guide and recommend supporting the example-inherit-from-community-image method?

jbusecke commented 2 months ago

Hey @jnywong, just coming back to this topic. Thanks for the nice write up. This will definitely save me a lot of time. Re your question above, I think this is not an either or question. I have used both cases (and templates)! Could I suggest resurrecting the old docs in a separate section with an explanation why the other should be preferred? As far as I understand @yuvipanda made the argument that this is more sustainable in the long run due to the maintenance done upstream, which makes tons of sense. I personally think that for more advanced users there might be a case for building from scratch (e.g. to save on downloading time).

jbusecke commented 2 months ago

Btw just linked to your amazing instructions in our docs. Many thanks!

jnywong commented 2 months ago

Hey @jnywong, just coming back to this topic. Thanks for the nice write up. This will definitely save me a lot of time. Re your question above, I think this is not an either or question. I have used both cases (and templates)! Could I suggest resurrecting the old docs in a separate section with an explanation why the other should be preferred? As far as I understand @yuvipanda made the argument that this is more sustainable in the long run due to the maintenance done upstream, which makes tons of sense. I personally think that for more advanced users there might be a case for building from scratch (e.g. to save on downloading time).

Thank you for your thoughtful response @jbusecke !

Yes, I was hesitant about removing references to this repo entirely and the user story you put forward makes a a lot of sense!

I'll make the README more clear and add references back into the 2i2c Service Guide to signpost for more advanced users :)