Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

GraphQL: Document CORS support #8465

Closed
3 of 8 tasks
keharper opened this issue Jan 3, 2021 · 5 comments
Closed
3 of 8 tasks

GraphQL: Document CORS support #8465

keharper opened this issue Jan 3, 2021 · 5 comments
Assignees
Labels
2.4.3 Community Docs impacted by community code contribution Major Update Significant original updates to existing content Partner: EY Progress: done

Comments

@keharper
Copy link
Contributor

keharper commented Jan 3, 2021

Community engineering issue

Type of Doc:

  • New topic
  • Topic Update, Devdoc link:
  • Other

Magento 2 GitHub Issue: magento/magento2#31195

Magento 2 GitHub PR: magento/magento2#31484

Magento 2 version:

  • 2.4

Notifications of Changes:

  • Changes to Admin interface?
  • New software requirements?
  • New REST endpoints or updated GraphQL query syntax?
  • New command line option?

Content

Do not start working on this issue until Magento has approved PR magento/magento2#31484

Add documentation that describes GraphQL CORS support.

CORS support was originally a feature targeted for 2.4.2, but Magento did not merge that code into mainline. You can use the text in #7629 as a starting point, if the code in magento/magento2#31484 is compatible. (#7815 reverted those doc updates.)

Additional information

CORS support is a 2.4.3 feature. Create your PR off of the 2.4.3-develop branch.

As of the moment I'm writing this issue, there is no 2.4.3-develop branch. If the 2.4.3-develop branch exists when you start working on this issue, create your PR against it. Otherwise, create the PR against the 2.4.2-develop branch with the knowledge that it will need to be rebased.

If this iteration of CORS support does not warrant a new topic, then be sure to break the symlink using the rake symlink:replace_at path=src/guides/v2.4/graphql/send-request.md command.

@keharper keharper added Major Update Significant original updates to existing content Community Docs impacted by community code contribution Partner: EY 2.4.3 labels Jan 3, 2021
@m2-assistant
Copy link

m2-assistant bot commented Jan 3, 2021

Hi @keharper. Thank you for your report.
To help us process this issue please make sure that you provided sufficient information.

Please, add a comment to assign the issue: @magento I am working on this


@G-Arvind
Copy link
Contributor

G-Arvind commented Jan 4, 2021

@magento I am working on this

@keharper
Copy link
Contributor Author

@G-Arvind If you've started working on this issue, be aware that there is now a 2.4.3-develop branch.

@keharper
Copy link
Contributor Author

This PR also contains documentation that was backed out.

magento/merchdocs#637

@keharper
Copy link
Contributor Author

keharper commented Feb 22, 2021

@G-Arvind A Magento development team is finishing the original PR. Do you want to submit a devdocs PR to cover the work that you completed, or would you prefer that I do all the work to complete this issue.

If you want to start the work and get the credit for it:

  1. Add the content that was originally committed in GraphQL: Add section about CORS #7629, making any updates.
  2. Break the symlink to src/guides/v2.4/config-guide/prod/config-reference-envphp.md by running rake symlink:replace_at path=src/guides/v2.4/config-guide/prod/config-reference-envphp.md.
  3. Update the config-reference-envphp.md file. Where applicable, you can re-use the text provided in Add GraphQL CORS screen merchdocs#637.

Please let me know your decision by Thursday, February 25.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.4.3 Community Docs impacted by community code contribution Major Update Significant original updates to existing content Partner: EY Progress: done
Projects
None yet
Development

No branches or pull requests

2 participants