fix: resolve conflicts (#93)

* Fix code example in data-fetching.zh-CN.mdx (#90) * Add license (#93) * Add license * Update license.md Co-authored-by: Paco <[email protected]> Co-authored-by: Shu Ding <[email protected]> Co-authored-by: Paco <[email protected]> * update perf page (#92) * I18n: Spanish (#96) * feat: added support for Spanish language * doc(language): now the footer text is on Spanish * docs(language): I18: Snpanish * docs(language): Added metadata Spanish * docs(language): I18 index spanish page * docs(language): I18 Getting started to spanish * docs(language): I18 Change log page to Spanish * feat(I18): Add metadata related to the example to Spanish * docs(I18): Basic use to the Spanish * docs(I18): Auth page to Spanish * docs(I18): Handleing error page to Spanish * docs(I18): Inifinite loading page to Spanish * feat(I18-spanish): added metadata related with advances section * docs(I18): Translated to Spanish * docs(I18): Added metadata related with documentation section * refactor: fix typo * docs(I18): Option translated to Spanish * docs(I18): Configuration global page translated to Spanish * docs(I18): Data fetching page translated to Spanish * docs:(I18): Error handling page translated to Spanish * refactor: Fixy typo * docs(I18): Automatic revalidation page translated to Spanish * docs(I18): Conditional data fetching page translated to Spanish * docs(I18): Arguments page translated to Spanish * docs(I18) Mutation page translated to Spanish * docs(I18): Pagination page translated to Spanish * docs(I18): Prefetching page translated to Spanish * docs(I18): Usage with Next.js page translated to Spanish * docs(I18): Suspense page translated to Spanish * refactor: performance page * docs(readme): Improving credits and add one more. (#97) * i18n: add Japanese Co-authored-by: Fang Lu <[email protected]> Co-authored-by: Joe Cohen <[email protected]> Co-authored-by: Shu Ding <[email protected]> Co-authored-by: Paco <[email protected]> Co-authored-by: Markoz Peña <[email protected]>
uttk · May 24, 2021 · b29c7b8 · b29c7b8
1 parent 8b08c3d
commit b29c7b8
Show file tree

Hide file tree

Showing 33 changed files with 1,834 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -14,4 +14,5 @@ And visit `localhost:3000` to preview your changes.
 ## Contributors
 
 - https://github.com/vercel/swr-site/graphs/contributors
-- Simplified Chinese translation done by @huzhengen
+- Simplified Chinese translation done by Fang Lu ([@huzhengen](https://github.com/huzhengen))
+- Spanish translation done by Markoz Peña ([@markozxuu](https://twitter.com/markozxuu)) 
diff --git a/components/features.js b/components/features.js
@@ -11,8 +11,9 @@ const Feature = ({ text, icon }) => (
 
 const TITLE_WITH_TRANSLATIONS = {
   'en-US': 'React Hooks library for data fetching',
+  'es-ES': 'Biblioteca React Hooks para la obtención de datos',
   'zh-CN': '用于数据请求的 React Hooks 库',
-  'ja': "データ取得のための React Hooks ライブラリ"
+  'ja': 'データ取得のための React Hooks ライブラリ',
 }
 
 export default () => {

diff --git a/license.md b/license.md
@@ -0,0 +1,190 @@
+                             Apache License
+                       Version 2.0, January 2004
+                    https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2021 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/next.config.js b/next.config.js
@@ -6,7 +6,7 @@ const withNextra = require('nextra')({
 
 module.exports = withNextra({
   i18n: {
-    locales: ['en-US', 'zh-CN', 'ja'],
+    locales: ['en-US', 'zh-CN', 'es-ES', 'ja'],
     defaultLocale: 'en-US'
   }
 })
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     "build": "STORK_PATH=$(pwd)/bin/stork.bin next build"
   },
   "author": "Shu Ding",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "dependencies": {
     "@reach/skip-nav": "^0.10.5",
     "focus-visible": "^5.1.0",

diff --git a/pages/advanced/meta.es-ES.json b/pages/advanced/meta.es-ES.json
@@ -0,0 +1,3 @@
+{
+  "performance": "Rendimiento"
+}
diff --git a/pages/advanced/performance.en-US.mdx b/pages/advanced/performance.en-US.mdx
@@ -67,18 +67,17 @@ function App () {
 }
 ```
 
-In the worst case (the first request failed, then the retry was successful), you will see 5 lines of logs:
+In the worst case (the first request failed, then the retry was successful), you will see 4 lines of logs:
 
 ```js
 // console.log(data, error, isValidating)
-undefined undefined false // => hydration / initial render
 undefined undefined true  // => start fetching
 undefined Error false     // => end fetching, got an error
 undefined Error true      // => start retrying
 Data undefined false      // => end retrying, get the data
 ```
 
-The state changes make sense. But that also means our component **rendered 5 times**.
+The state changes make sense. But that also means our component **rendered 4 times**.
 
 If we change our component to only use `data`:
 

diff --git a/pages/advanced/performance.es-ES.mdx b/pages/advanced/performance.es-ES.mdx
@@ -0,0 +1,122 @@
+# Rendimiento
+
+SWR proporciona una funcionalidad crítica en todo tipo de aplicaciónes web, por lo que el **rendimiento**
+es una prioridad absoluta.
+
+SWR’s tiene **caché** incorporado y la **[deduplicación](/advanced/performance#deduplication)** evitan las solicitudes de red innecesarias,
+pero el rendimiento del propio hook `useSWR` sigue siendo importante. En una aplicación compleja, puede haber cientos de llamadas `useSWR`
+en una solo página.
+
+SWR asegura que su aplicación tiene:
+
+- _no hay peticiones de red innecesarias_
+- _no hay renderizado innecesarios_
+- _no se importa código innecesario_
+
+sin ningún cambio de código por su parte.
+
+## Deduplicación
+
+Es muy común reutilizar los hooks SWR en tu aplicación. Por ejemplo, una aplicación que muestra el avatar del usuario
+actual 5 veces:
+
+```jsx
+
+function useUser() {
+   return useSWR('/api/user', fetcher)
+}
+
+function Avatar () {
+   const { data, error } = useUser()
+   if (error) return <Error />
+   if (!data) return <Spinner />
+
+   return <img src={data.avatar_url} />
+}
+
+function App() {
+  return <>
+    <Avatar />
+    <Avatar />
+    <Avatar />
+    <Avatar />
+    <Avatar />
+  </>
+}
+
+```
+
+Cada componente `<Avatar/>` tiene un hook `useSWR` en su interior. Dado que tienen el mismo key SWR y 
+que se renderizan casi al mismo tiempo, **sólo se hará 1 solicitud de red**.
+
+Puedes reutilizar tus hooks de datos (como `useUser` en el ejemplo anterior) en todas partes, sin preocuparte por el rendimiento
+o las peticiones duplicadas.
+
+También existe la [opción `dedupingInterval`](/docs/options) para anular el intervalo de deduplicación por defecto.
+
+## Comparación profunda
+
+SWR por defecto tiene  **deep compares** al cambio de datos. Si el valor de `data` no ha cambiado, no se
+activará una nueva renderización.
+
+También puede personalizar la función de comparación mediante la [opción `compare`](/docs/options) si quieres cambiar el comportamiento.
+Por ejemplo, algunas respuestas de la API devuelven una marca de tiempo del servidor que tal vez quiera excluir de la difusión de datos.
+
+## Coleción de dependencias
+
+`useSWR` devuelve 3 valores de **estado**: `data`, `error` y `isValidating` cada uno de ellos puede actualizarse de forma independientemente.
+Por ejemplo, si imprimimos esos valores dentro de un ciclo de vida completo de obtención de datos, será algo como esto:
+
+```jsx
+
+function App () {
+  const { data, error, isValidating } = useSWR('/api', fetcher)
+  console.log(data, error, isValidating)
+  return null
+}
+
+```
+
+En el peor de los casos (la primera solicitud falló, entonces el reitento fue exitoso), verá 4 líneas de registros:
+
+```js
+// console.log(data, error, isValidating)
+
+undefined undefined true  // => start fetching
+undefined Error false     // => end fetching, got an error
+undefined Error true      // => start retrying
+Data undefined false      // => end retrying, get the data
+```
+
+Los cambios de estado tienen sentido. Pero eso también significa que nuestro componente se **renderizo 4 veces.**
+
+Si cambiamos nuestro componente para usar solo `data`:
+
+```jsx
+
+function App () {
+   const { data } = useSWR('/api', fetcher)
+   console.log(data)
+   return null
+}
+```
+
+La magia ocurre - ahora solo hay **2 rederizaciones**:
+
+```js
+// console.log(data)
+undefined // => hydration / initial render
+Data      // => end retrying, get the data
+```
+
+El mismo proceso ha ocurrido internamente, hubo un error de la primera solicitud, entonces tenemos los datos del reintento.
+Sin embargo, **SWR sólo actualiza los estados que utiliza el componente**, que ahora sólo es `data`.
+
+Si no utiliza siempre estos 3 estados, ya se está beneficiando de esta función. En [Vercel](https://vercel.com), esta optimización se 
+traduce en un 60% menos de repeticiones.
+
+## Tree Shaking
+
+El paquete SWR es [tree-shakeable](https://webpack.js.org/guides/tree-shaking) y no tiene efectos secundarios.
+Esto significa que si sólo importa `useSWR` core API, las APIs no utilizadas, como `useSWRInfinite`, no se incluirán en tu aplicación.
+