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

Wiki and Active Attic were needed a long time ago. #775

Open
Catoptromancy opened this issue Oct 19, 2021 · 7 comments
Open

Wiki and Active Attic were needed a long time ago. #775

Catoptromancy opened this issue Oct 19, 2021 · 7 comments

Comments

@Catoptromancy
Copy link
Contributor

Catoptromancy commented Oct 19, 2021

Github has a wiki section that has yet to be enabled for Freedoom. I think each lump or series of lumps should have its own entry. We can then link those entries to the attic. Credits for every lump included or submitted at some point will be on those entry pages.

An active attic and wiki setup like this can easily see entire history of a lump, who made what version, and include direct links to that specific version of the resource from the attic. Will show who created lump, who edited it, may also include how it was edited.

A way of sorting lumps will be "directory pages."
A directory page will show a collection of related lumps. Whether they come as a natural set like a sprite, or just uploaded from same author in a similar style. Multiple directory pages can be used to separate graphics/music/maps for easy browsing. Other types of directory pages can be used to find each lump by version or even author.

Not sure about directory pages, just need a system that can grep out information. Maybe a single text file with information on everything in the attic in a kind of single row table.

This is just a kind of brainstorming, but need a similar system for linking attic to wiki is needed.

@selliott512
Copy link
Contributor

This is a nice idea. For those not familiar the attic is a repo with previous Freedoom resources.

This suggestion is based on lumps, but relating things to files in the Freedoom repo is easier for me to visualize. Maybe I need to understand it better.

On a somewhat related note I've thought about writing a script that would find all level replacements, that is all significant changes to levels/*.wad files based on a binary diff that suggests a replacement instead of a small fix. Doing so should produce a complete list of all Freedoom levels that ever existed. Maybe this concept could be applied to other files. Let me know if it would be helpful and I can pursue it.

@Catoptromancy
Copy link
Contributor Author

Getting all the lumps into an easily viewable state was the main goal. That script sounds like a great idea. No idea on how to host that though.

Each lump its own page? Each type of lump gets a page? Each section of lumps, like an entire monsters sound effects or graphics? Maybe some type of sorting program that uses "each lump its own page" that can then filter lumps a certain way.

Once all the lumps are paged, we can figure out how to credit everyone.

@mc776
Copy link
Contributor

mc776 commented Jan 27, 2023

I wonder how feasible it would be to reorganize the attic so the higher-up folders are sprites, graphics, patches, lumps, etc. and then the person who had submitted something - right now you have to already know who did what in order to find anything, when often that's one of the things I'm in the attic trying to figure out in the first place.

@Mr795
Copy link
Contributor

Mr795 commented Dec 14, 2023

Github has a wiki section that has yet to be enabled for Freedoom. I think each lump or series of lumps should have its own entry. We can then link those entries to the attic. Credits for every lump included or submitted at some point will be on those entry pages.

An active attic and wiki setup like this can easily see entire history of a lump, who made what version, and include direct links to that specific version of the resource from the attic. Will show who created lump, who edited it, may also include how it was edited.

A way of sorting lumps will be "directory pages." A directory page will show a collection of related lumps. Whether they come as a natural set like a sprite, or just uploaded from same author in a similar style. Multiple directory pages can be used to separate graphics/music/maps for easy browsing. Other types of directory pages can be used to find each lump by version or even author.

Not sure about directory pages, just need a system that can grep out information. Maybe a single text file with information on everything in the attic in a kind of single row table.

This is just a kind of brainstorming, but need a similar system for linking attic to wiki is needed.

So its basically gonna be an archive of the history of each asset, I personally think this is an amazing idea. But wouldn't it be a bit tedious to right down each and every contributor and what year their version of the asset was contributed? that's one thing i thought about while reading this.

@Mr795
Copy link
Contributor

Mr795 commented Dec 14, 2023

Github has a wiki section that has yet to be enabled for Freedoom. I think each lump or series of lumps should have its own entry. We can then link those entries to the attic. Credits for every lump included or submitted at some point will be on those entry pages.
An active attic and wiki setup like this can easily see entire history of a lump, who made what version, and include direct links to that specific version of the resource from the attic. Will show who created lump, who edited it, may also include how it was edited.
A way of sorting lumps will be "directory pages." A directory page will show a collection of related lumps. Whether they come as a natural set like a sprite, or just uploaded from same author in a similar style. Multiple directory pages can be used to separate graphics/music/maps for easy browsing. Other types of directory pages can be used to find each lump by version or even author.
Not sure about directory pages, just need a system that can grep out information. Maybe a single text file with information on everything in the attic in a kind of single row table.
This is just a kind of brainstorming, but need a similar system for linking attic to wiki is needed.

So its basically gonna be an archive of the history of each asset, I personally think this is an amazing idea. But wouldn't it be a bit tedious to right down each and every contributor and what year their version of the asset was contributed? that's one thing i thought about while reading this.

also i may have another idea for that wiki such as: including stuff that happened in the project like the story of the copyright violations in 0.6.3's source, which caused all versions besides 0.6.4+ to get removed from the project site. (good thing those versions are archived in the historic repo.)

@Ferk
Copy link
Contributor

Ferk commented Feb 17, 2024

About the wiki: I would suggest not relying on github-exclusive features too much. Specially for a FOSS-focused project.

If in the future the project was moved to codeberg, gitlab or whatever other platform we would lose all the wiki information.

Personally, I'd rather that any info, history or docs that would belong to a wiki be added to the freedoom.github.io repo instead. I believe it's using asciidoc format for the pages, just like the manual is (even if the extension is .txt instead of .adoc). That way the information would be public in the official page, and if anyone wants to contribute (like a wiki) they can just submit a PR with the change.

@Calinou
Copy link
Contributor

Calinou commented Feb 17, 2024

About the wiki: I would suggest not relying on github-exclusive features too much. Specially for a FOSS-focused project.

Remember that any GitHub wiki can be cloned as Markdown using git clone https://github.com/USER/REPOSITORY.wiki.git. The edits are available as Git commits. This allows archiving a wiki easily in case it becomes unavailable in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants