blog icon indicating copy to clipboard operation
blog copied to clipboard

[proposal] drop assets ID

Open stas00 opened this issue 3 years ago • 6 comments

As disscused here https://github.com/huggingface/blog/pull/507#discussion_r974616495 and multiple times before the asset prefix ID (https://github.com/huggingface/blog/tree/main/assets) is not being used anywhere and it very often interferes with blog post PRs when multiple new PRs are opened, each using the same next id and a race condition ensues - the first to merge wins, the other open PRs now have to rename the assets folder and move files to the next id, and again a race condition occurs.

I propose to remove the id altogether and solve the race condition.

~Ideally we can then rewrite all the existing blog posts to remove the id as well to avoid confusion for future authors which may try to copy the old setup.~ (not good for direct links to previous assets)

Thank you!

stas00 avatar Sep 20 '22 18:09 stas00

Ideally we can then rewrite all the existing blog posts to remove the id as well to avoid confusion for future authors which may try to copy the old setup.

As discussed before (can't find the thread right now...), we shouldn't rename the existing folders because it would break the existing assets URLs linked from the Internet

So this leaves us with the options of 1/ ommitting the id going forward, or 2/ not changing anything.

I'm fine with both.

Let's put those two options to a vote maybe?

julien-c avatar Sep 20 '22 19:09 julien-c

Ideally we can then rewrite all the existing blog posts to remove the id as well to avoid confusion for future authors which may try to copy the old setup.

As discussed before (can't find the thread right now...), we shouldn't rename the existing folders because it would break the existing assets URLs linked from the Internet

like diagrams - yes, that's a very good point. Thank you for thinking of that, Julien.

So this leaves us with the options of 1/ ommitting the id going forward, or 2/ not changing anything.

I'm fine with both.

Let's put those two options to a vote maybe?

Sounds good to me.

stas00 avatar Sep 20 '22 20:09 stas00

or actually, 3/ option people can do whatever they want i.e. they can keep adding a number or not

julien-c avatar Sep 22 '22 10:09 julien-c

That works, Julien.

As it doesn't look like anybody else is going to chime in, should we just update the guide to use the 3rd option instead?

stas00 avatar Sep 22 '22 15:09 stas00

sounds good to me

Thanks for finding a satisfactory middleground with me :)

julien-c avatar Sep 23 '22 06:09 julien-c

https://github.com/huggingface/blog/pull/538

stas00 avatar Sep 23 '22 15:09 stas00

this has been solved

julien-c avatar Feb 03 '23 15:02 julien-c