Revisit how we talk about "projects"
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
URL to the relevant guide or resource
https://quantum.cloud.ibm.com/docs/en/guides/considerations-set-up-runtime
https://quantum.cloud.ibm.com/docs/en/guides/quickstart-steps-org#4-create-access-groups-for-projects
Select all that apply
- new content request
- typo
- code bug
- out-of-date content
- broken link
- other
Describe the fix or the content request.
These two guides talk primarily about "projects", rather than "instances".
That is potentially confusing because IQP has no concept of projects, such as how the UI never mentions projects. So, when you go to use our platform, we have a mismatched concept.
Fran explained this is the relationship between projects and instances:
1 project == 1 instance, yes. That's inherited from the previous hub/group/project model and because our clients are not cloud integrators, so the concept of instance means nothing, but a project they work with does
While we should probably still mention the word project, in my opinion, we should lean much more heavily into instance because that is what they're going to encounter everywhere in our platform. They already are going to encounter new concepts like "CRNs". We should probably still teach something like "You can think of an instance like a project", but then use "instance" from there.
When working on this, use ripgrep to search for other references to project.
For new content requests - if the request is accepted, do you want to write the content?
I only want to review the material when it's finished
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the considerations-set-up-runtime and quickstart-steps-org guides linked in the issue, then use ripgrep to find other references to “project.” Update the relevant wording so instances are the primary term while still explaining their relationship to projects, and check the affected guides for consistent terminology and accurate links.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100