Hedgedoc to work on documentation?

Special Interest Groups SIG Documentation
1

Hey, I’m thinking of hosting a hedgedoc instance so we can start writing actual documentation.

One of the PRs that’s currently open presents an opportunity for something we can document and I think having a hedgedoc instance would help us work a little faster.

Thoughts?

I can get the instance up in like an hour or two if everyone’s in agreement.

1 Like
2

I think its a cool idea but I don’t believe there was a settled agreement on what software we were using.

2 Likes
3

Hedgedoc is just markdown, we can just export the files out once we know what software we’ll be using. :thinking:

2 Likes
4

Thats a pretty fair evaluation. If thats the case then I’m happy for you to get started.

1 Like
5

Okay, I got a hedgedoc instance up and running at: https://auxdocs.foss.life, it uses GitHub logins for the moment so it’s easy to just hop in and start working on stuff.

Feel free to use this to block out some documentation ideas or get started on documentation until we figure out what we’ll actually use for documenting stuff.

3 Likes
6

Thanks for settings this up. Definitely a good way to get started.

2 Likes
7

Lemme know if you run into any issues using it!
I’ve been playing around with it and so far I haven’t hit any issues myself, but you can never be too sure. :smile:

2 Likes
8

Thanks a bunch for doing this… Will test tomorrow during SIG-Security Call :tada:

3 Likes
9

While HedgeDoc is indeed very useful, just like ¹ There Ain’t No Such Thing As Plain Text, there is also no such thing as “just Markdown”. That’s why Pandoc offers a gazillion ² of Markdown dialects to convert between.

Unfortunately, the Markdown dialect used by HedgeDoc doesn’t seem to be CommonMark nor the dialect GitHub or GitLab use and (as far as I’m aware) isn’t even one of the many that Pandoc supports (or at least not with all of HedgeDoc’s not-so-standard Markdown features).

That being said, documents that aren’t too long and complicated or that don’t use many exotic features can usually be somewhat feasibly converted by some ad-hoc combination of automatic conversion, textual search-replace on the source code and manual editing of the source code.

¹ (but orthogonal to the plain text encoding question)
² figure grossly exaggerated for rhetoric / dramatic effect

2 Likes
10

I see. I wasn’t aware that it wasn’t commonmark.
If there’s any better alternatives I could host, please let me know and I’ll get that up and running. :blush:

3 Likes
11

Yeah my thinking too. I rather have easy collaboration from the start with the downside of doing a one-time migration effort than struggling over a tool to help us nurture good collaboration :wink:
“Everything is temporary” as they say in Factorio :wink:

4 Likes