From 716130e696d9c61a95e0d0f2bcdfc2425547807a Mon Sep 17 00:00:00 2001 From: Augustina Ragwitz Date: Wed, 1 May 2019 13:49:13 -0700 Subject: [PATCH 1/2] Update documentation template to match recommendations from doc sprints --- .../ISSUE_TEMPLATE/20-documentation-issue.md | 31 +++++++++++++++---- 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.md b/.github/ISSUE_TEMPLATE/20-documentation-issue.md index 7123ca6d6c5073..864f9b091273d2 100644 --- a/.github/ISSUE_TEMPLATE/20-documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.md @@ -4,14 +4,33 @@ about: Use this template for documentation related issues --- -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 +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 via [Google Groups](https://groups.google.com/a/tensorflow.org/forum/#!forum/docs) or [email](mailto:docs@tensorflow.org list) 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 +## 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). From fd434c5486b16cbef9ba5622e6650a929c939019 Mon Sep 17 00:00:00 2001 From: Billy Lamberta Date: Thu, 2 May 2019 14:59:29 -0700 Subject: [PATCH 2/2] Attempt to fix email link preview --- .github/ISSUE_TEMPLATE/20-documentation-issue.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/20-documentation-issue.md b/.github/ISSUE_TEMPLATE/20-documentation-issue.md index 864f9b091273d2..4fa20da1f4148e 100644 --- a/.github/ISSUE_TEMPLATE/20-documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/20-documentation-issue.md @@ -4,7 +4,9 @@ about: Use this template for documentation related issues --- -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 via [Google Groups](https://groups.google.com/a/tensorflow.org/forum/#!forum/docs) or [email](mailto:docs@tensorflow.org list) 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 +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 ## Existing URLs containing the issue: Link to the documentation entry, for example: https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod