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.

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

update tutorials MLCube links to the main repo, not forks #418

Closed
hasan7n opened this issue Apr 21, 2023 · 1 comment
Closed

update tutorials MLCube links to the main repo, not forks #418

hasan7n opened this issue Apr 21, 2023 · 1 comment
Assignees
Labels
project: Core topic: documentation Improvements or additions to documentation
Milestone

Comments

@hasan7n
Copy link
Contributor

hasan7n commented Apr 21, 2023

Also wondering: how this is usually approached? Is there a solution out there? (Now each time we want to change such links, we will end up adding another PR to use the main repo's URLs)

@hasan7n hasan7n added the topic: documentation Improvements or additions to documentation label Apr 21, 2023
@aristizabal95 aristizabal95 added this to the Q2 milestone Apr 24, 2023
@VukW VukW self-assigned this Dec 21, 2023
@VukW
Copy link
Contributor

VukW commented Dec 22, 2023

#517

Commit: 880e5c9

I do see three possible solutions:

  1. Just change the link to main's HEAD: so, you add new file in PR, during PR dev the link is wrong (it still leads to main's HEAD), but right after merge everything starts to be ok.
  • -: the links are "unstable", i.e. the same link to mlcommons/medperf/main/path/to/file.yaml may lead to different files once we update repo. Although I expect that files in main branch always be in proper state...
  • -: new links do not work properly until PR is merged
  • +: if master is always stable, links are always synced with current tutorial (that's built on master branch also)
  1. Use tags: make a tutorial-content tag and point to it in the link. So, link would be https://raw.githubusercontent.com/mlcommons/medperf/tutorial-content/path/to/file.yaml .
  • +: we can "move" the tag independently from main branch. I.e. until we do not change tutorials, tag would point on the exactly same commit not depending on new commits over main branch.
  • +: we even can tag a commit outside of main branch - say, use a separate branch for storing tutorial yamls.
  • -: still very hacky and weirdo. We still can move tag (or remove totally) independently of tutorial, making tutorials unconsciously broken.
  1. use another hosting - say, storage.googleapis.com as you use it for binaries.

I've implemented (1), while believe that (3) is the best option

@VukW VukW closed this as completed Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project: Core topic: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants