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

Create an issue / PR template that makes sense for documentation #9

Open
3 tasks
alexellis opened this issue Apr 6, 2018 · 5 comments
Open
3 tasks
Labels
PR A PR is open that addresses this issue

Comments

@alexellis
Copy link
Member

This should loosely model the templates used for the "faas" repo but have specific questions / prompts which relate to adding documentation.

Checkpoints may include:

  • I have tested the markdown appearance with Docker
  • I have tested any new instructions
  • I am the author or have permission to share this text and reference the source
@alexellis alexellis added the help wanted Extra attention is needed label Apr 6, 2018
@ericstoekl
Copy link
Contributor

  • is it an integration guide, developer guide, or core product usage guide?
  • link to the documentation where it currently exists, e.g. if this is something that exists as a .md file in a repo, link to that.
  • link to your version of the site with the proposed changes added (built+deployed in your public GitHub pages)

@johnmccabe
Copy link
Contributor

johnmccabe commented Apr 6, 2018

Type of change

  • new content
  • correction
  • improvement

Complexity of change

This would be for labels docs:minor, docs:major

  • minor
  • major

@alexellis
Copy link
Member Author

We don’t produce a product - OpenFaaS is an open source project.

Good discussion.. anything from @rgee0 ?

@rgee0
Copy link
Contributor

rgee0 commented Apr 9, 2018

Is the documentation covering a new feature - please reference. We should be able to track docs against features & don't want to be merging out of order.

Who from the community "peer reviewed/tested". Could be done by GH review but I think theres a stage prior to that. If a 3rd party hasn't been able to follow what's been written then it cant be evidenced that its ready for PR.

@alexellis
Copy link
Member Author

@johnmccabe would you like to put this together?

@rgee0 rgee0 added PR A PR is open that addresses this issue and removed help wanted Extra attention is needed labels Oct 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR A PR is open that addresses this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants