Set up skeleton for Additional Resources dropdown #1671
Conversation
Eric-Arellano
force-pushed
the
EA/set-up-resources
branch
from
2fb32d6 to
3fdaea3
Compare
| @@ -0,0 +1,40 @@ | |||
| { | |||
There was a problem hiding this comment.
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": "Qiskit SDK", | ||
| "children": [ | ||
| { | ||
| "title": "Version strategy", |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I dont see the deprecation policy line in this file? Or is the diff just bad? I just see version strategy then contributor guide
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
ah ok yeah keeping it in the version strategy page is fine by me 👍
| "url": "/open-source/qiskit-sdk-version-strategy" | ||
| }, | ||
| { | ||
| "title": "Contributor guide", |
There was a problem hiding this comment.
Idk if there's a better name
| "url": "https://github.com/Qiskit/qiskit/blob/main/CONTRIBUTING.md" | ||
| }, | ||
| { | ||
| "title": "Maintainer guide", |
There was a problem hiding this comment.
Idk if there's a better name
docs/open-source/code-of-conduct.mdx
Outdated
| @@ -0,0 +1,119 @@ | |||
| --- | |||
| title: Code of conduct | |||
| description: TODO | |||
There was a problem hiding this comment.
This needs to be done before the folder goes live in 2-3 weeks. Idk if we want to do it now, or later?
There was a problem hiding this comment.
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."
| description: TODO | ||
| --- | ||
|
|
||
| # Code of Conduct |
There was a problem hiding this comment.
The below is copied from Qiskit SDK repo
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
| @@ -0,0 +1,8 @@ | |||
| --- | |||
There was a problem hiding this comment.
We can fill in this content later
| @@ -0,0 +1,6 @@ | |||
| --- | |||
There was a problem hiding this comment.
Note there is no _toc.json and this is in the top-level docs folder
|
Bump @abbycross @javabster |
|
I think I misunderstood @Eric-Arellano - this will go into production but not show up in publication until we populate the files? Or would we use this unmerged branch to build the content? |
|
@abbycross this will be merged to qiskit/documentation, but not synced to the closed source repo until we tell it to be. So, these files will not go live in production at all. The motivation for merging this now is to facilitate future PRs in qiskit/documentation. |
There was a problem hiding this comment.
👍 (would like @javabster and others to weigh in on file naming but this makes sense to me!)
|
@javabster feel free to merge this or make any changes you want while I'm OOO tomorrow |
Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
This sets up the new URLs for the `/open-source` folder (Qiskit#605) and the `/responsible-quantum-computing` page (Qiskit#1576). The content is not yet synced to production. This only sets up the empty pages and `_toc.json` so that we can develop the content more easily. -- Note that the URLs do not have `/additional-resources/` or `/resources` in them. We decided this in Qiskit#1360 so that the URLs are shorter and more flexible to future reorganization. `/responsible-quantum-computing` is not in a folder and does not have `_toc.json` because it is a standalone page, similar to `/support`. If we ever decide to expand it into a folder, we can do that by adding a `/responsible-quantum-computing`, so long as we add an `index.mdx` file. Migration guides will be moved over once we are ready with redirects. (They actually technically never have to be moved.) <img width="267" alt="Screenshot 2024-07-15 at 9 47 18 AM" src="https://github.com/user-attachments/assets/47836660-63fa-494f-8a4b-aba3fc427059"> --------- Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
This sets up the new URLs for the
/open-sourcefolder (#605) and the/responsible-quantum-computingpage (#1576).The content is not yet synced to production. This only sets up the empty pages and
_toc.jsonso that we can develop the content more easily.--
Note that the URLs do not have
/additional-resources/or/resourcesin them. We decided this in #1360 so that the URLs are shorter and more flexible to future reorganization./responsible-quantum-computingis not in a folder and does not have_toc.jsonbecause it is a standalone page, similar to/support. If we ever decide to expand it into a folder, we can do that by adding a/responsible-quantum-computing, so long as we add anindex.mdxfile.Migration guides will be moved over once we are ready with redirects. (They actually technically never have to be moved.)