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.

Sign up for GitHub

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

Jump to bottom

Update documentation template to match recommendations from doc sprints #28319

Merged
merged 2 commits into from
May 3, 2019
Merged

Update documentation template to match recommendations from doc sprints #28319

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
716130e
Update documentation template to match recommendations from doc sprints
missaugustina May 1, 2019
fd434c5
Attempt to fix email link preview
lamberta May 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions .github/ISSUE_TEMPLATE/20-documentation-issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,35 @@ about: Use this template for documentation related issues

---

<em>Please make sure that this is a documentation issue. As per our [GitHub Policy](https://github.com/tensorflow/tensorflow/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:doc_template</em>
<em>Thanks so much for taking the time to file a documentation issue and even more thanks if you intend to contribute to updating it! Please do introduce yourself on our mailing list with
[Google Groups](https://groups.google.com/a/tensorflow.org/forum/#!forum/docs) or
[email](mailto:docs@tensorflow.org) and let us know if you have any questions. We also encourage you to review our [Documentation Contributor Guide](https://www.tensorflow.org/community/contribute/docs). As a side note, per our [GitHub Policy](https://github.com/tensorflow/tensorflow/blob/master/ISSUES.md), we only address code/doc bugs, performance issues, feature requests and build/installation issues on GitHub. tag:doc_template</em>

## Existing URLs containing the issue:
Link to the documentation entry, for example: https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod

**System information**
- TensorFlow version:
- Doc Link:
## Description of issue (what needs changing):

### Correct Links
Is the link pointing to the source code correct? To find the source code, use `git grep my_method` from the git command line in your locally checked out repository.

**Describe the documentation issue**
### Clear Description
Why should someone use this method? How is it useful?

**We welcome contributions by users. Will you be able to update submit a PR (use the [doc style guide](https://www.tensorflow.org/community/documentation)) to fix the doc Issue?**
### Usage Example
Is there a usage example?

### Parameters Defined
Are all arguments that can be passed in defined and formatted correctly?

### Returns Defined
Are return values defined?

### Raises Listed and Defined
Are errors defined? [Example](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises)

### Request Visuals, if Applicable
Are there currently visuals? If not, would they make the content clearer?

### Submit PR?
Are you planning to also submit a [Pull Request](https://help.github.com/en/articles/about-pull-requests) to fix this issue? See the [Documentation Contributor Guide](https://www.tensorflow.org/community/contribute/docs) the [Documentation Style Guide](https://www.tensorflow.org/community/contribute/docs_style).