report necessary docs changes here

[denise]

With Bugzilla defunct (RIP), we're still talking over what the process will be for reporting docs-related bugs, since they won't quite belong in the replacement system (Github Issues) we'll be using for code bugs. In the meantime, as you spot FAQs that need to be updated (or added), leave a comment here just so we don't forget them before we work out the replacement.

Comments

[ironymaiden]

Hi. I'm interested in volunteering to write and edit content, but I haven't found any information on how to do that yet. Sorry to clutter this thread, but I'm at a loss.

Can someone point me in the right direction?

[denise]

Never apologize for asking for info! especially when it's a "uh, denise, you really need to get your ass in gear and decide on an Actual Process" situation. (By which I mean, I've sort of been procrastinating on figuring out a good workflow, because everything anybody has come up with has enough drawbacks that I keep going "eh, we can figure out something better" and then not coming up with anything that isn't going to involve huge code changes.) We're using the dw-free Github Issues repo for now alongside code issues, since long-term the goal is to get all the FAQs under better version control anyway, but that's not a super high priority project as opposed to the other eight billion things on the List...

Anyway! Hi! Welcome! We'd love to have you working on docs, even though we still need to clean up the process! azurelunatic and kaberett are our docs deities these days; you may see either one of them in Github Issues handling things.

For now: Check out the manual of style and the Documentation category on the wiki -- some of the stuff in the category is old (it's been a while since I've had the time to go through the wiki and flag stuff that's no longer current or in need of update) but it's good background. Then, download and read the Contributor Licensing Agreement, sign the last page, and send it back to me.

(The CLA basically says you keep the rights to any of your contributions but grant us a permanent license to use and redistribute them; it establishes that we can't hold you responsible in the future if something goes Horribly Wrong and, like, your code causes a rift in the space/time continuum; and it binds us to always offering your contributions to our free-software-licensed repos under a license that's at least as permissive as the one in force when you submitted it -- in other words, we promise that we'll never take the source entirely closed as long as we're still operating the site. It's basically to cover our asses and the asses of our contributors in case of a future dispute.)

Once you've sent in a CLA, create a Github account (and let me know the username, so you might want to do that before sending the CLA) and bookmark/watch the dw-free repo. When you see a FAQ that should be changed/expanded/rewritten, or identify a FAQ that should exist but doesn't, open an issue and add your suggested text or changes to the issue; one of us will take it from there.

(We don't have a complete list of "docs changes that need to be made", so if you want to make "making that list" a first priority, you can also log docs issues without also writing the new copy!)