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

Set up skeleton for Additional Resources dropdown #1671

Merged
merged 6 commits into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
40 changes: 40 additions & 0 deletions docs/open-source/_toc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Reviewers: pay attention to the file names and URLs. This is what makes up the left ToC. This ToC reflects the Qiskit dev meeting this morning: #605 (comment)

(We can always adjust things until this goes live)

"title": "Open source",
Eric-Arellano marked this conversation as resolved.
Show resolved Hide resolved
"collapsed": true,
"children": [
{
"title": "Code of conduct",
"url": "/open-source/code-of-conduct"
},
{
"title": "Contributor license agreements",
"children": [
{
"title": "Individual contributor",
Eric-Arellano marked this conversation as resolved.
Show resolved Hide resolved
"url": "https://docs.quantum.ibm.com/open-source/qiskit-cla.pdf"
},
{
"title": "Corporate contributor",
"url": "https://docs.quantum.ibm.com/open-source/qiskit-corporate-cla.pdf"
}
]
},
{
"title": "Qiskit SDK",
"children": [
{
"title": "Version strategy",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is aka the deprecation policy. It explains what the policy is, whereas the DEPRECATION.md file in qiskit repo explains the tactics of how maintainers write deprecations.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I dont see the deprecation policy line in this file? Or is the diff just bad? I just see version strategy then contributor guide

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We were thinking the deprecation guide should be linked inside the "Version strategy" file, rather than having a dedicated external link in the left ToC. What do you prefer? We can add an external link like "Deprecation techniques" or "Deprecation guide"

Copy link
Collaborator

Choose a reason for hiding this comment

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

ah ok yeah keeping it in the version strategy page is fine by me 👍

"url": "/open-source/qiskit-sdk-version-strategy"
},
{
"title": "Contributor guide",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Idk if there's a better name

"url": "https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md"
},
{
"title": "Maintainer guide",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Idk if there's a better name

"url": "https://github.com/Qiskit/qiskit/blob/main/MAINTAINING.md"
}
]
}
]
}
119 changes: 119 additions & 0 deletions docs/open-source/code-of-conduct.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
title: Code of conduct
description: TODO
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This needs to be done before the folder goes live in 2-3 weeks. Idk if we want to do it now, or later?

Copy link
Collaborator

Choose a reason for hiding this comment

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

we could fill it now: "The Qiskit Code of Conduct defines and enforces the values and conduct of contributors and participants in the Qiskit open source community."

---

# Code of Conduct
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The below is copied from Qiskit SDK repo

Copy link
Collaborator

Choose a reason for hiding this comment

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

Did you talk with the qiskit devs about this page? I'm not sure if we should copy-paste it in here or just use an external link?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I didn't talk to them about whether it should be in the docs page vs a link to Qiskit SDK repo. @1ucian0 any thoughts?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm fine with duplicating the page, i think it's important content, but we just need to make sure it doesn't go out of date if the qiskit repo version changes

Copy link
Collaborator

Choose a reason for hiding this comment

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

just chatted with luciano, neither of us feel strongly about wether it should be in docs or a link out, so lets just go with whatever is simpler to implement :D

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

To clarify, I was envisioning updating Qiskit/qiskit to point to the page once it goes live with text like:

This project follows the code of conduct at docs.quantum.ibm.com/open-source/code-of-conduct.


## Our Pledge

The Qiskit Community is dedicated to our values of treating every individual
with respect and dignity. In the interest of fostering an open and welcoming
environment, all participants, including attendees, speakers, sponsors,
volunteers, online contributors, and IBM employees are expected to show
courtesy for each other and our community by creating a harassment-free
experience for everyone, regardless of age, personal appearance, disability,
ethnicity, gender identity and expression, body size, level of experience,
nationality, race, religion, caste, or sexual identity and orientation.
Expected behavior applies to both online and offline engagement within the
Qiskit Community.

## Scope

The purpose of this Code of Conduct is to define and enforce the values and
conduct of contributors and participants in the Qiskit open source community.
The Code of Conduct applies both within project spaces and in public spaces
when an individual is engaging with the Qiskit open source community. Examples
include attending a Qiskit event, contributing to online projects, commentary
on Slack, or representing a project or community, including using an official
project e-mail address, posting via an official social media account, or
acting as an appointed representative at an online or offline event.
Representation of a project may be further defined and clarified by project
maintainers.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints, experiences, and cultures
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
- Being mindful of your surroundings and your fellow participants and listening
to others
- Valuing the contributions of all participants
- Engaging in collaboration before conflict
- Pointing out unintentionally racist, sexist, casteist, or biased comments and
jokes made by community members when they happen

Examples of unacceptable behavior by participants, even when presented as
"ironic" or "joking," include:

- The use of sexualized language or imagery and unwelcome physical contact,
sexual attention, or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment, including offensive or degrading language
- Publishing others' private information, such as a physical or electronic
address, without explicit permission. This includes any sort of "outing" of
any aspect of someone's identity without their consent.
- "Doxxing," Publishing screenshots or quotes, especially from identity slack
channels, private chat, or public events, without all quoted users' explicit
consent.
- Engaging in spamming activities, such as repeatedly sending unsolicited messages, LLMs (Large Language Models) output, advertisements, or promotional content to community members without previous IBM authorization.
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Responsibilities & Enforcement

The entire Qiskit community is responsible for upholding the terms of the Code
of Conduct in Qiskit Community events and spaces and reporting violations if
they see them. The internal Qiskit team at IBM is ultimately responsible for
clarifying the standards of acceptable behavior and enforcement, and is expected
to take appropriate and fair corrective action in response to any instances of
unacceptable behavior.

If a participant or contributor engages in negative or harmful behavior, IBM
will take any action they deem appropriate, including but not limited to
issuing warnings, expulsion from an event with no refund, deleting comments,
permanent banning from future events or online community, or calling local law
enforcement. IBM has the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to temporarily or permanently ban any
contributor or participant for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

If you see a Code of Conduct violation:

1. If you feel comfortable, let the person know that what they did is not
appropriate and ask them to stop and/or edit or delete their message(s) or
comment(s).
2. If the person does not immediately stop the behavior or correct the issue,
or if you're uncomfortable speaking up, flag a moderator and, if appropriate,
fill out the anonymous
[Code of Conduct violation form](https://airtable.com/shrl5mEF4Eun1aIDm).
3. The Qiskit Community will open an investigation upon receiving your form
entry. When reporting, please include any relevant details, links,
screenshots, context, or other information that may be used to better
understand and resolve the situation.
4. If the code of conduct violation occurs at an event and requires immediate
response or contains a concern about an individual attending an upcoming
event, contact the event's on-call Code of Conduct point of contact listed
in the event specific code of conduct document. If you don't feel comfortable
speaking to the point of contact in person, fill out a Code of Conduct
violation form entry and include the details of the event so that the Code of
Conduct enforcement board can contact the event's on-call Code of Conduct
point of contact.
5. If an IBM employee witnesses a Code of Conduct violation at any time, such as
at events, in a Slack channel, or open source forums, it is their
responsibility to file a Code of Conduct violation report.

This Code of Conduct does not supersede existing IBM corporate policies, such as
the IBM Business Conduct Guidelines and IBM Business Partner Code of Conduct.
IBM employees must follow IBM's Business Conduct Guidelines. IBM's business
partners must follow the IBM Business Partner Code of Conduct. IBM employees
concerned with a fellow IBMer's behavior should follow IBM's own internal HR
reporting protocols, which include engaging the offending IBMer's manager and
involving IBM Concerns and Appeals. IBM employees concerned with an IBM
business partner's behavior should notify tellibm@us.ibm.com.
8 changes: 8 additions & 0 deletions docs/open-source/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We can fill in this content later

title: Open source
description: TODO
---

# Open source

Blah blah
6 changes: 6 additions & 0 deletions docs/open-source/qiskit-sdk-version-strategy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Qiskit SDK version strategy
description: TODO
---

# Qiskit SDK version strategy
6 changes: 6 additions & 0 deletions docs/responsible-quantum-computing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note there is no _toc.json and this is in the top-level docs folder

title: Responsible quantum computing
description: TODO
---

# Responsible quantum computing
Loading