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: mentioned missing info regarding putting npm organization while… #3513

Closed
wants to merge 1 commit into from

Conversation

raimuhammad26
Copy link

… importing workspace

For coherence on the page, I mentioned the missing information of adding the npm organization or user space as well if it is there in the imported workspace's package.json file as part of it's name during import of a workspace in another workspace.

For example, if it is @mycompany/shared-utils instead of shared-utils.

This case is not mentioned in the 'Workspaces which depend on each other' section.

Currently the 'Workspaces which depend on each other' section only explains the case where npm organization or user space is not part of the imported workspace's name

… importing workspace

For coherence on the page, I mentioned the missing information of adding the npm organization or user space as well if it is there in the imported workspace's `package.json` file as part of it's `name` during import of a workspace in another workspace.

For example, if it is `@mycompany/shared-utils` instead of `shared-utils`.

This case is not mentioned in the Workspaces which depend on each other' section.

Currently the 'Workspaces which depend on each other' section only explains the case where npm organization or user space is not part of the imported workspace's `name`
@raimuhammad26 raimuhammad26 requested a review from a team as a code owner January 27, 2023 16:52
@vercel
Copy link

vercel bot commented Jan 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

8 Ignored Deployments
Name Status Preview Comments Updated
examples-basic-web ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-cra-web ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-designsystem-docs ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-native-web ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-nonmonorepo ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-svelte-web ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-tailwind-web ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)
examples-vite-web ⬜️ Ignored (Inspect) Jan 27, 2023 at 4:53PM (UTC)

@vercel
Copy link

vercel bot commented Jan 27, 2023

@mbsc26 is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions bot added the area: docs Improvements or additions to documentation label Jan 27, 2023
@nathanhammond
Copy link
Contributor

Hey @mbsc26! Thank you for the PR.

We explicitly specify the name of the package in a previous step in this walkthrough. If the user chooses to add a namespace to the package name we assume that they're also capable of knowing that they will need to further adjust the following steps accordingly.

{
  "name": "shared-utils"
}

I'm going to close this as it is advanced usage beyond what we intend to cover in our walkthrough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants