Create official documentation - formatting guide, content guidelines, DMCA process documentation

[G-Ambatte]

Following the removal of /u/AeronDrake's "formatting guide on the Homebrewery" due to copyright issues, a replacement document is required. However this has also highlighted the need for a clear process for copyright holders to report the misuse of their material, and a clearly documented process for handling such a claim.

[Gazook89]

I'm all for a quick overview, but I think a way to designate "guide" brews would allow for more depth on topics while being easier to contribute to. Maybe that means simply using a flair on Reddit (either the existing tips and tricks or a new "official documentation" flair), or a GitHub wiki, or Reddit wiki.

[Mikle103]

Sorry just have a question here re the removal of the formatting guide, I just browsed to it on homebrewery?

https://homebrewery.naturalcrit.com/share/HJWLQsTwUZ

Could I please have some insight into what you are referring to? Just very curious that is all.

I have several guides I use for my Homebrewerying.

Great work love the recourse and please keep it up, cannot wait for V3 to go live.

[Gazook89]

The guide is still up on HB but the link has been pulled from Reddit. The guide will be replaced or edited (if possible) but still working that out.

[Mikle103]

Thanks for the info, I found the above link via reddit as I have a downloaded version I use.
Just for your information.
it was in a sub redddit u/unearthedarcana

https://www.reddit.com/r/UnearthedArcana/comments/6q81jx/homebrewery_formatting_guide/

[Gazook89]

With v3 it sounds like there will be a new "Welcome Page" that utilizes the new Markdown syntax, and is an editable scratchpad. Here are two quick attempts at that...I like option A more, myself.

Option A: Only shows examples, leaving user to look at the code in the editor itself.

Option B: Adds the code into code blocks in the brew itself. I think this is too cluttered for this type of document.

Option C: open to suggestions

---

Also, here is a much longer reference document that may just be handy to have a link to. I have to update it for the latest changes in the syntax (equals signs to colons, etc) but will likely hold off on that until we are on the doorstep of pushing v3 live to be sure it's up to date.

[calculuschild]

I'm thinking option A. Although maybe you can use one code block just to demo it because it is a new thing to v3.

[calculuschild]

As far as DMCA removals, since we just had another one, I'll document the process I used:

I simply went in and appended "dmca" to the shareId each file, so it was no longer accessible via the share link, but edit link was still working. In the case of a Google Drive file, I had to add some extra code to make this work, just on my local repo as a temporary measure, similar to how we update view counts on google drive files via the "service account" credentials. I'll note that doing so made the Google file disappear from the user's user page since we access Google Drive documents via the "share" protocol. Clearly this is only a hacky, temporary measure to handle this.

Now that we have better per-file metadata working, we can probably now add a "Blocked" field or something to brews to streamline this; attempting to view a shared file with that field will instead receive a page stating "This file has been temporarily blocked due to a copyright claim.... etc." And on the edit link, the user would receive a popup stating something similar, but we could give them a more personalized message (image "elven archer" on page 6 is infringing on copyright etc. etc.).

Of course adding some kind of "internal messaging" system via #1908 would allow us to alert users of the issue without just hoping they open the brew in question to get the popup. We could also potentially put some alert icon on any blocked brews in the user page so while looking at their brews they are clearly marked.

[5e-Cleric]

This should be done with #3326, and we are working on a content policy to follow the publishing of #3263.

I will track it in this brew as a start.