wca-documents icon indicating copy to clipboard operation
wca-documents copied to clipboard

(Semi-)permanent links for motions

Open Nanush7 opened this issue 11 months ago • 5 comments

Whenever a motion is amended, its number changes. This means that any link that points to the motion's document stops working. This makes it necessary to update several documents, and we often forget to do so.

It would be easier to have permanent (or at least semi-permanent) links to motions (e.g., by their name, ignoring the number). The only reason I see to keep the links as they are, is to make it clear that a referenced motion has been updated since it was referenced (e.g., if referenced in an announcement or email).

If we want to proceed with this idea, I'm willing to have a look and propose the required changes.

Nanush7 avatar Jan 21 '25 20:01 Nanush7

Yes, this is something the Board wanted us to do. What kind of solutions do you have in mind?

mintydev789 avatar Jan 28 '25 10:01 mintydev789

Keep in mind, the solution should also make it so that links linking to the old version of each motion don't break. Perhaps, the built files should just exclude the date part from the end of the file name of each motion.

mintydev789 avatar Jan 28 '25 10:01 mintydev789

Keep in mind, the solution should also make it so that links linking to the old version of each motion don't break

Is that a new feature we want? There's no way to access previous versions of the motions currently (apart from doing it via git).

the built files should just exclude the date part from the end of the file name of each motion

Yeah, that's an example I mentioned in the description, I think it would be the easiest way to do it.

To make it possible to have permanent links to historical versions, we can also store the files in directories by month and year on S3 (so that, for example, the URL would look like .../documents/motions/2025.1/Spirit.pdf), if the WST is fine with that. The latest version of each document should be stored on a separate directory (e.g. .../documents/motions/latest/Spirit.pdf). This would give you the option to make a link always point to the latest version, or to a specific version.

Nanush7 avatar Jan 28 '25 16:01 Nanush7

Keep in mind, the solution should also make it so that links linking to the old version of each motion don't break

Is that a new feature we want? There's no way to access previous versions of the motions currently (apart from doing it via git).

the built files should just exclude the date part from the end of the file name of each motion

Yeah, that's an example I mentioned in the description, I think it would be the easiest way to do it.

To make it possible to have permanent links to historical versions, we can also store the files in directories by month and year on S3 (so that, for example, the URL would look like .../documents/motions/2025.1/Spirit.pdf), if the WST is fine with that. The latest version of each document should be stored on a separate directory (e.g. .../documents/motions/latest/Spirit.pdf). This would give you the option to make a link always point to the latest version, or to a specific version.

I meant that moving forward, all links should be version-agnostic, so that links don't break in the future. We don't need to make past versions available.

mintydev789 avatar Jan 28 '25 16:01 mintydev789

Well, in that case, I guess it's as easy as removing the number from the file name.

Nanush7 avatar Jan 28 '25 17:01 Nanush7