documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Published 20 hours ago • verified publisher icon Graylog2

Add `CONTRIBUTING`

Open asachs01 opened this issue 3 years ago • 4 comments

Context

The docs project seems to be missing a CONTRIBUTING.md doc that would outline the expectations for both internal and external contributors to the docs. See Sensu's CONTRIBUTING doc for an example. Some other notes about what to include in our version:

  • How to build/test the docs locally (Moving what we currently have in the README)
  • Branch/naming conventions
  • Do we prefer fork/branch or just branch off of the prod branch to add new content
  • Any stylistic elements that are critical for community contributions

asachs01 avatar Oct 06 '20 16:10 asachs01

@bernd @asachs01 Can I help you guys? I can move over the necessary stuff from the README.md

devaslooper avatar Oct 27 '20 13:10 devaslooper

Howdy @devaslooper ! I'm soooooo behind on my github notifications 😓 . If you want to, I'm totally down for it.

asachs01 avatar Nov 24 '20 02:11 asachs01

  • How to build/test the docs locally (Moving what we currently have in the README)
  • Branch/naming conventions
  • Do we prefer fork/branch or just branch off of the prod branch to add new content
  • Any stylistic elements that are critical for community contributions

Hey, @asachs01 !!! I would like to work on this issue. But can you tell me from where I would get the above quoted info?

ghost avatar Mar 16 '21 11:03 ghost

Ok, I figured out about

  • How to build/test the docs locally (Moving what we currently have in the README)

For this issue > *Do we prefer fork/branch or just branch off of the prod branch to add new content) what I can guess is that we should use fork/branch. For the rest two I have need your help @asachs01

ghost avatar Mar 16 '21 13:03 ghost