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

Update documentation template to match recommendations from doc sprints #28319

Merged
merged 2 commits into from May 3, 2019

Conversation

Projects
7 participants
@missaugustina
Copy link
Contributor

commented May 1, 2019

Example issue from @dynamicwebpaige this template is based on - #25794

TF API 2.0 Symbol documentation: https://docs.google.com/document/d/1e20k9CuaZ_-hp25-sSd8E8qldxKPKQR-SkwojYr_r-U/edit

Tensorflow doc sprint tasks: https://docs.google.com/spreadsheets/d/1p3vqbocbKmcZQGrlxk9m2jHuleu8yr-XRbfKum0IDD8/edit#gid=0

From Gwitter conversation:
Augustina Ragwitz @missaugustina 12:51
There is a link to file a new docs issue in the README for the docs repo that uses a template that I'm not sure is current. I can file a bug for this against the docs repo - https://github.com/tensorflow/tensorflow/issues/new?template=20-documentation-issue.md
or maybe i can't.. .guess it would have to go in the main TF repo

Billy Lamberta @lamberta 13:17
The template shown yesterday was a proposal, but I agree it's better than what we have now. @margaretmz or @lc0 (or whoever) , can you make a PR for the new docs issue template on tensorflow/tensorflow? I think that file is here: https://github.com/tensorflow/tensorflow/blob/master/.github/ISSUE_TEMPLATE/20-documentation-issue.md

Augustina Ragwitz @missaugustina 13:19
I can do that
i just need the new suggested template
i didn't get a link yesterday, was it shared? i don't remember seeing it

Billy Lamberta @lamberta 13:20
Thanks. Yeah, I don't have it, I believe Margaret and Sergii have it

Augustina Ragwitz @missaugustina 13:22
i'll start a PR
i have the one Paige used in her example update, if anyone wants to suggest the new one I can update or someone else can

@tensorflow-bot tensorflow-bot bot added the size:S label May 1, 2019

@googlebot

This comment has been minimized.

Copy link

commented May 1, 2019

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added the cla: no label May 1, 2019

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 1, 2019

I've signed the CLA

@lamberta
Copy link
Member

left a comment

Thanks, Augustina!
A few link updates but looks good

Show resolved Hide resolved .github/ISSUE_TEMPLATE/20-documentation-issue.md Outdated
Show resolved Hide resolved .github/ISSUE_TEMPLATE/20-documentation-issue.md Outdated

@rthadur rthadur added this to Assigned Reviewer in PR Queue via automation May 1, 2019

@rthadur rthadur self-assigned this May 1, 2019

@lc0

This comment has been minimized.

Copy link
Contributor

commented May 1, 2019

@missaugustina Thank you for proposing it! I think it should definitely save some time to people attending the sprints.

@lamberta I just found, that github also supports labels for template. Should be try to automatically add docs label? What do you think?

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 1, 2019

In the tensorflow repo, not everyone has access to set labels, so I'm not sure how it would work in a template.

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 1, 2019

I signed it

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 1, 2019

I'll submit the label as a separate PR since we're not 100% certain how permissions would work

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 1, 2019

I signed it

@lamberta

This comment has been minimized.

Copy link
Member

commented May 1, 2019

Having some CLA issues and I've started an internal thread to see where the problem is. Sorry about that, will get it figured out

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 2, 2019

I signed it!

@googlebot

This comment has been minimized.

Copy link

commented May 2, 2019

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@googlebot googlebot added cla: yes and removed cla: no labels May 2, 2019

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 2, 2019

Rebased to a single commit & updated with requested changes.

@rthadur rthadur requested a review from lamberta May 2, 2019

@lamberta
Copy link
Member

left a comment

Thanks, Augustina! This will be really helpful.

PR Queue automation moved this from Assigned Reviewer to Approved by Reviewer May 2, 2019

@missaugustina

This comment has been minimized.

Copy link
Contributor Author

commented May 2, 2019

I checked the errors on the failed builds, are those experimental queues? The errors don't appear (to me) to have anything to do with changing the doc template in the .github dir.

@lamberta

This comment has been minimized.

Copy link
Member

commented May 2, 2019

@missaugustina The CI builds runs a snapshot of the tensorflow so it may be picking up errors that were not necessarily caused by this PR. I'm following this as it moves through the process, and it should be fine, but PRs to tensorflow/tensorflow can take a while. Sorry!

@tensorflow-copybara tensorflow-copybara merged commit fd434c5 into tensorflow:master May 3, 2019

12 of 15 checks passed

Linux GPU Internal CI build failed
Details
MacOS Python2 and CC Internal CI build failed
Details
Windows Bazel GPU Internal CI build failed
Details
Android Demo App Internal CI build successful
Details
MacOS Contrib Internal CI build successful
Details
Ubuntu CC Internal CI build successful
Details
Ubuntu Makefile Internal CI build successful
Details
Ubuntu Python2 Internal CI build successful
Details
Ubuntu Python3 Internal CI build successful
Details
Ubuntu Python3 PIP Internal CI build successful
Details
Ubuntu Sanity Internal CI build successful
Details
Ubuntu contrib Internal CI build successful
Details
Windows Bazel Internal CI build successful
Details
cla/google All necessary CLAs are signed
import/copybara Change imported to the internal review system
Details

PR Queue automation moved this from Approved by Reviewer to Merged May 3, 2019

tensorflow-copybara pushed a commit that referenced this pull request May 3, 2019

@missaugustina missaugustina deleted the missaugustina:update-doc-issues-template branch May 7, 2019

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