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.

Sign up for GitHub

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

Jump to bottom

Update doc replace to vite #11352

Merged
merged 10 commits into from
Jan 29, 2024
Merged

Update doc replace to vite #11352

merged 10 commits into from
Jan 29, 2024

Conversation

gento-ogane
Copy link
Contributor

#11305

In Vite, default file name is main.jsx instead of index.js, so I replaced index.js to main.jsx.

Checklist:

  • If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
  • If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
  • Make sure all of the significant new logic is covered by tests

@gento-ogane gento-ogane requested a review from a team as a code owner November 9, 2023 10:14
@apollo-cla
Copy link

@gento-ogane: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

@netlify Netlify
Copy link

netlify bot commented Nov 9, 2023 •
edited
Loading

‼️ Deploy request for apollo-client-docs rejected.

Name Link
🔨 Latest commit 32b4dc7

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 9, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 32b4dc7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jerelmiller jerelmiller linked an issue Nov 9, 2023 that may be closed by this pull request
The section get-started should recommend Vite instead of CRA. #11305
Closed
@gento-ogane gento-ogane mentioned this pull request Nov 14, 2023
Closed
@jerelmiller
Copy link
Member

Thanks for the contribution @gento-ogane! We'll do our best to get to this PR as soon as we can. A couple of our team is at conferences this week so we may be a bit slow to get to this. Apologies in advance!

illyakurochkin
illyakurochkin reviewed Dec 25, 2023
View reviewed changes
docs/shared/link-chain.mdx Outdated
@@ -1,4 +1,4 @@
```js title="index.js"
```jsx title="main.jsx""
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did you change it to jsx?

jerelmiller
jerelmiller requested changes Jan 18, 2024
View reviewed changes
Copy link
Member

@jerelmiller jerelmiller left a comment

Choose a reason for hiding this comment

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

Hey @gento-ogane 👋

I am so sorry it took me so long to get back to you on this PR! I had some time to sit down and run through the getting started to make sure everything still worked/made sense and all looks good!

The only change I'd request you make is reverting the changes in type/filenmae to all docs except the "Getting started" page. Once you're done there, I'd be happy to approve this PR and get this merged. Thanks so much for your patience 🙏

docs/shared/link-chain.mdx Outdated
@@ -1,4 +1,4 @@
```js title="index.js"
```jsx title="main.jsx""
Copy link
Member

Choose a reason for hiding this comment

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

I'd prefer to revert the changes to all the non-introductory docs back to index.js. I think it makes sense in the context of the vite-specific documentation, but for the rest of it, index.js is a fairly common, tool agnostic name.

On a separate note, it looks like you have an extra " at the end here 🙂

docs/source/get-started.mdx

```js title="index.js"
```jsx title="main.jsx"
Copy link
Member

Choose a reason for hiding this comment

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

I think these changes in the context of this doc are totally fine! Your justification that its a Vite default makes sense 🙂

jerelmiller
jerelmiller approved these changes Jan 29, 2024
View reviewed changes
Copy link
Member

@jerelmiller jerelmiller left a comment

Choose a reason for hiding this comment

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

Thanks a bunch for your contribution @gento-ogane! I'm sure new newcomers will really appreciate this change 🙂

@jerelmiller jerelmiller merged commit 2ebb0c5 into apollographql:main Jan 29, 2024
23 of 24 checks passed
@gento-ogane
Copy link
Contributor Author

@jerelmiller
Sorry I did not notice your reply...
Thanks for your review and commit and merge!!

@jerelmiller
Copy link
Member

You're very welcome!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@illyakurochkin illyakurochkin illyakurochkin left review comments

@jerelmiller jerelmiller jerelmiller approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The section get-started should recommend Vite instead of CRA.
4 participants
@gento-ogane @apollo-cla @jerelmiller @illyakurochkin