Submitted 2 days ago by a_gee_dizzle@lemmy.ca to [deleted]
For example, if I want to collaborate on making a (non-computer related) textbook with someone, and we want to use git as a version control system. Should we use github/codeberg for this or is there a platform that’s more suitable for using git in nontechnical contexts?
There’s a different hub, where people all share their porn. A porn hub if you will.
It’s called Xhamster.
And here i was, thinking there was only YouPorn.
Git is for text in general, not only for code. As long as it’s human readable (I don’t know if doc or odt files can be used), git can work with it.
I don’t know if doc or odt files can be used
Much easier to keep the content in plain text as markdown/LaTeX/whatever markup language and then use pandoc or pdflatex to convert it to docx/odt/pdf/HTML/whatever as needed.
There are ways to store office formats as single XML files, look up “flat XML ODF”. Those are more suitable for repos than ordinary zipped ODF or OOXML files.
diff wouldn’t be any useful but it’ll still work
once.com/writebook maybe?
If it helps, a number of courses at my university used open source git based textbooks. For example, you can replicate this Statistics textbook using any static site generator designed for documentation: moderndive.com (github.com/moderndive/ModernDive_book/)
We use vitepress for our docs: fedecan.ca/en/guide/get-started
Or you can get even simpler by using plain markdown files organized into folders
Thanks for the info.
In my opinion, it’s better to start off simple while writing the content since then you can pick a tool based on what type of formatting you end up needing
Yeah I guess there should be rudimentary markdown to LaTeX translation programs, right?
Yeah I guess there should be rudimentary markdown to LaTeX translation programs, right?
I haven’t tried any, but I would think so yes. You can probably run a script over the files to accomplish the same thing :)
pandoc. Converts markdown to html, latex, pdf, and Word.
It serves as the backend behind basically every program that support some kind of rendering of markdown, e.g. quarto, ipython notebooks.
Pandoc - Pandoc User’s Guide - pandoc.org/MANUAL.html
There’s a pizza recipe on github.
Yeah, most academics I know collaborate on git. They have zero code. Just use it for datasets and such.
Another example is datasets on covid infections and deaths from John Hopkins Uni. They used github.
I’m consistently surprised by the number of my friends that use github who are not coders.
If you’re into self hosting and you want to collaborate with other writers, there’s Bookstack
interesting. how does it do with collaboration? the guy im working with has no tech knowledge really so i dont want to make it too complicated for him
It’s been quite a few years since I used it, but iirc users log in and have access to the chapters and pages that already exist, so they are able to edit them as they see fit. Likewise they can create new chapters and/or pages that would be accessible to other users.
Overleaf also has a self-hosted option in case you want to collaborate in LaTeX projects.
We always used Overleaf (LaTeX) for assignments because we couldnt figure out how to compile it on 3 different OSs lol
Plenty of people use git hosting to host non-code, like documentation, books written in markdown/LaTeX, etc. I personally use git to maintain a few personal wikis.
Different git forges will have different rules about what content they allow. GitHub definitely allows non-code. I’ve seen Codeberg repos be used for non-code too. Codeberg’s only requirement is that you only host free (as in freedom) content, so I suppose for non-code that means using an appropriate CC licence for example. I can’t imagine any of the popular git hosting sites taking issue with someone hosting their book, unless you’re hosting, like, the whole of Wikipedia or something.
Specifically for writing textbooks, you might enjoy looking at https://www.americanyawp.com/ for inspiration. Their documentation is light on technical details but you could email the contacts at the bottom of https://www.americanyawp.com/text/about/ with questions about how to structure your specific project.
This seems like a good resource thanks for sharing
I haven’t found anything better than codeberg. The following novella is a reflection on my experience with a similar problem.
I have all my poetry and short stories (and D&D snippets and board game / video game design snippets and screenplays and draft policy proposals and diatribes on the nature of being and other misc stuff that’s hard to categorize) in a single giant git repo. It works okay though I find it really hard to organize everything in a strictly hierarchical structure and I often have a hard time finding things I wrote because I can’t remember if it’s in the “boardgames” dir or the “video_games” dir, etc. I don’t think anyone but me would ever be able to use it. Not because it’s too esoteric, but because the organizational structure grew up organically over the years and makes no sense when viewed in its current form without an understanding of the history of the repo. It’s a very similar phenomenon to opening up an old code repo for the first time and being overwhelmed by the messiness of it, when someone who has been maintaining the repo for years has a built up schema of how the repo is acutally organized and can navigate it somewhat more effectively than someone new to the project
What I’m saying is that keeping git repos organized sensibly over time is really hard, even when dealing with something as highly structured as source code, and IMO it’s much harder with more loosely-categorized creative writing snippets, if for no other reason than there’s not a strong tradition of creative writers using collaborative editing tools like VCS (though there are, I think, other good reasons why it’s harder).
If I were to reformat my repo, I would probably start by trying to come up with a more formalized type system, a formalized metadata system, and a linking system (e.g. I would like to be able to create a link from a scene in a script to a character bio or a macguffin description). You can do links with markdown if you’re familar with it, I sometimes do that but I am pretty inconsistent with it, most of the time its too much bother to maintain them when I keep shuffling documents around (because I don’t have a well-defined type system…). Obsidian also has this feature; I haven’t been able to get myself into a natural flow writing Obsidian documents, but it’s worth checking out I think as a tool for creative writing on top of a VCS like git. If none of these sound immediately useful they can be put off until they’re needed since it’s easy to overcomplicate projects in the beginning by anticipating future problems that may never materialize, these are just things that I want for my own writing style.
Whether or not you use something like obsidian, I think for creative collaborative projects it’s perfectly doable to use git, but it makes sense to spend some time at the top thinking about the shared rules that collaborators will need to know in order to keep all the contributors from stepping on each others’ toes. These rules should be in the repo itself in a README and should be regularly reviewed by collaborators because you will almost certainly find better ways of doing things as the project grows. These rules should cover things like:
main before it goes to editorial review? or do you want to have feature branches that editors review and approve before merging to main?If you are like me, all this might sound like extreme overkill for something as simple as loosely structured creative writing. That’s because it is, until a project grows beyond a certain size, and historically I do not recognize that size boundary until I am well past it and my repo is an unmaintainable mess. It might help to discuss with your collaborators what they think the project would look like when it’s a few years and a few complete projects old: what problems will you want to solve then? Can they be anticipated in a way that doesn’t unduly burden the very difficult task of getting the whole endeavor started? A little of that can go a long way to preventing the project from losing steam because they repo just gets too unwieldy to be fun to write in.
I have been tinkering with this idea for a project file oriented version control software
I’m not sure if it’s in a state that I can share it yet but if you want to take a look I’m calling it duh.
I plan to eventually create an entire DuhHuh to serve as GitHub for everyone.
Interesting, thanks for sharing it. I hope DuhHuh goes well.
I used to use github for my course materials, currucula, and syllabi when I was a teacher.
Google sheets or Microsoft office. I don’t know if a dedicated platform exists but I would not expect a large demand given the alternatives.
I feel like there was a radiolab or freakonomics episode about this exact problem. What am I thinking of?
Any version control system works for this.
If you want something fairly user friendly, maybe look at Joplin or Logseq which are both specifically for text.
There’s PornHub.
Semi_Hemi_Demigod@lemmy.world 2 days ago
You could totally use GitHub for this if you format it with LaTeX or Markdown.
SincerityIsCool@lemmy.ca 2 days ago
Seconding this! I did my science writing in grad school with git and markdown.
a_gee_dizzle@lemmy.ca 2 days ago
awesome
Sunrosa@lemmy.world 2 days ago
You can also use typst. It’s a modern alternative for LaTeX.