#246 Adding an official user guide?

Open
opened 2 months ago by thombles · 1 comments

Hi all, I noticed this project is active again and I wondered if you want to offer some HTML user docs. You may have come across the The Unofficial GNU Social Manuals for which I wrote most of the user guide back in 2018. The admin manual was a sphinx-ification and tidy-up of the plain text docs that were already in the GNU social repo.

Since then the rendered output has been on my personal website and the RST/sphinx source was hosted in git.gnu.io. I noticed recently that my account on that git server is no more, but I located a backup of the repo which I have now reuploaded: https://github.com/thombles/social-doc

Is there any interest in using any of this material on the new website? For the time being I don't do microblogging so I'm not sure what's changed. If there is a desire to use the material and work is needed to get it in the right format for ongoing maintenance, I'll do what I can to assist in that transition.

Alternatively, maybe it's out of date or the quality is poor, and the best thing would be to take it offline! Happy to go with whatever the current maintainers feel like.

Hi all, I noticed this project is active again and I wondered if you want to offer some HTML user docs. You may have come across the _The Unofficial GNU Social Manuals_ for which I wrote most of the user guide back in 2018. The admin manual was a sphinx-ification and tidy-up of the plain text docs that were already in the GNU social repo. Since then the rendered output has been [on my personal website](https://thomask.sdf.org/social/en/) and the RST/sphinx source was hosted in git.gnu.io. I noticed recently that my account on that git server is no more, but I located a backup of the repo which I have now reuploaded: https://github.com/thombles/social-doc Is there any interest in using any of this material on the new website? For the time being I don't do microblogging so I'm not sure what's changed. If there is a desire to use the material and work is needed to get it in the right format for ongoing maintenance, I'll do what I can to assist in that transition. Alternatively, maybe it's out of date or the quality is poor, and the best thing would be to take it offline! Happy to go with whatever the current maintainers feel like.
Diogo Cordeiro commented 2 months ago
Owner

Hey, I was going to contact you today. As a matter of fact, yesterday, I added credits to you on the docs: https://code.undefinedhackers.net/GNUsocial/gnu-social/commit/5e9cd21db5b809a92137c0381dd6de8456b34c5b and wanted to ask if there's someone else that should also be referred :)

We're making GNU social v3 docs available at https://docs.gnusocial.rocks/ , v3 is still a Work In Progress, more about it at https://www.gnusocial.rocks/v3/ .

Your docs are still mostly correct for v2 with only some minor changes on Queues, Caching, how plugins are managed, etc. We can probably just update them, add the source to the v2 repo and make it available under https://www.gnusocial.rocks/v2/ .

I'll share this issue in IRC too ^^

Hey, I was going to contact you today. As a matter of fact, yesterday, I added credits to you on the docs: https://code.undefinedhackers.net/GNUsocial/gnu-social/commit/5e9cd21db5b809a92137c0381dd6de8456b34c5b and wanted to ask if there's someone else that should also be referred :) We're making GNU social v3 docs available at https://docs.gnusocial.rocks/ , v3 is still a Work In Progress, more about it at https://www.gnusocial.rocks/v3/ . Your docs are still mostly correct for v2 with only some minor changes on Queues, Caching, how plugins are managed, etc. We can probably just update them, add the source to the v2 repo and make it available under https://www.gnusocial.rocks/v2/ . I'll share this issue in IRC too ^^
Sign in to join this conversation.
No Milestone
No assignee
2 Participants
Loading...
Cancel
Save
There is no content yet.