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

[Docs] Add support page for issues, requests, and questions #3835

Merged
merged 6 commits into from
Mar 2, 2021

Conversation

rmlarose
Copy link
Contributor

To increase user feedback and make it clear how to report issues on the website.

cc @balopat @lamberta @karlunho

Note: Cirq is the only repo with issue templates.

@rmlarose rmlarose requested review from cduck, vtomole and a team as code owners February 18, 2021 20:55
@google-cla google-cla bot added the cla: yes Makes googlebot stop complaining. label Feb 18, 2021
@@ -68,6 +68,11 @@ upper_tabs:
- title: "Operators and observables"
path: /cirq/operators_and_observables

#### Support ####
- heading: "Support"
- title: "Issues / requests / questions"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you anticipate additional pages? Best to avoid single entry sections, if possible. Can add to the "Contributor guide" below until then

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, there probably won't be additional pages so the single-entry section may be overkill. Then again, it does make this page stick out which I think is good. What do others think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 new section

Copy link
Collaborator

@vcatherine vcatherine Feb 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My view is that we should not add this under contributor guide, since the point of adding this is to encourage more feedback from users outside of the contributor community. If we do not want to add a section I would suggest adding this at the bottom of the "further topics" section

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to further topics!

docs/support.md Outdated
# Questions

If you're not sure whether a certain behavior is buggy, or if you have other questions,
please ask us in the [Cirq Gitter channel](https://gitter.im/cirqdev).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we link to any email lists, such as cirq-dev? Eventually we should probably link to QCS support email lists, but maybe not yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this idea. I'll add a link to cirq-dev.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Copy link
Contributor

@balopat balopat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@balopat balopat added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Mar 2, 2021
@CirqBot CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Mar 2, 2021
CirqBot added 2 commits March 2, 2021 13:13

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@CirqBot CirqBot merged commit 8d17c73 into quantumlib:master Mar 2, 2021
@CirqBot CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants