Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proposal: create contribution guidelines for technical writers #33323

Open
nathany opened this issue Jul 27, 2019 · 1 comment

Comments

@nathany
Copy link
Contributor

commented Jul 27, 2019

(notes from GopherCon Community Day)

  • Technical writer friendly workflow (e.g. edit on GitHub to submit a pull request)
  • The kinds of documentation (tutorial, reference, quick reference, blog posts)
  • Style guide or link to one

Also:

@gopherbot gopherbot added this to the Proposal milestone Jul 27, 2019

@gopherbot gopherbot added the Proposal label Jul 27, 2019

@mvdan

This comment has been minimized.

Copy link
Member

commented Jul 28, 2019

I don't think the current contribution guide is exclusively about code, though. For example, the main repository has a doc/ folder, and there are files like src/cmd/compile/README.md which serve as technical documentation.

I think it's fair to highlight how to contribute documentation, but we should also be clear about where each kind of documentation lives.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.