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: Re-add wml instructions for linking @faststore/api #1171

Closed
wants to merge 3 commits into from

Conversation

filipewl
Copy link
Contributor

@filipewl filipewl commented Mar 15, 2022

What's the purpose of this pull request?

In #1055 we added instructions on properly linking, due to duplicate instances of the graphql-js package, a local @faststore/api package to a store. However, that section got removed by mistake in #1060 while we were migrating the documentation.

This PR adds the instructions back into the CONTRIBUTING.MD file: https://github.com/vtex/faststore/blob/docs/wml/CONTRIBUTING.MD#linking-local-changes-from-faststoreapi.

References

@filipewl filipewl added the documentation Improvements or additions to documentation label Mar 15, 2022
@filipewl filipewl requested a review from a team as a code owner March 15, 2022 15:34
@filipewl filipewl self-assigned this Mar 15, 2022
@codesandbox-ci
Copy link

codesandbox-ci bot commented Mar 15, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 50b8914:

Sandbox Source
Store UI Typescript Configuration

Copy link
Member

@eduardoformiga eduardoformiga left a comment

Choose a reason for hiding this comment

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

Nice catch! 👏

I left some suggestions, but not blocking.

CONTRIBUTING.MD Outdated Show resolved Hide resolved
CONTRIBUTING.MD Outdated Show resolved Hide resolved
@igorbrasileiro
Copy link
Contributor

Those steps didn't work for me.

Co-authored-by: Eduardo Formiga <eduardo.formiga@gmail.com>
Copy link
Contributor

@icazevedo icazevedo left a comment

Choose a reason for hiding this comment

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

I think this is still relevant, correct? Can we merge it?

@emersonlaurentino
Copy link
Member

@filipewl what is needed to merge this pr?

@hellofanny
Copy link
Contributor

@filipewl wands I think this PR is ready to merge. Can you try to trigger the CI again pls (checks incomplete 😞)?

@filipewl
Copy link
Contributor Author

Hey! I need to re-test the steps because there's more to it than what is initially described (e.g. you also need to install Watchman and even then there are some issues with it). I'll go over the steps again, also test it with the NextJS repo, and will update the docs accordingly.

@filipewl
Copy link
Contributor Author

Closing this as it's no longer needed now that we're using Turborepo. Thanks for the reminder @emersonlaurentino!

@filipewl filipewl closed this Jan 13, 2023
@filipewl filipewl deleted the docs/wml branch January 13, 2023 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants