docs(storage-resize-images): restructure the kit README to match the firestore-bigquery-export kit README

Abierto
#3,314 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 7 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
54/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo

Línea de trabajo

Start with kits/storage-resize-images/README.md and compare its sections with kits/firestore-bigquery-export/README.md at commit 3ded546a. Wait for PRs #3285, #3287, #3289, #3306 and #3307 to merge, then reorganize their content into the specified section order and add the missing guidance where applicable. Done when the README follows that structure, includes the Region subsection in Differences, and reflects the merged PR content.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation kits

storage-resize-images kit README. Priority: low. Do this last, after the other sub-issues of #3263 have landed.

What

Restructure kits/storage-resize-images/README.md so it is similar in structure and length to kits/firestore-bigquery-export/README.md. At kits @ 3ded546a, the FBE README is 418 lines and 2,450 words; this one is 330 lines and 2,278 words.

Follow the FBE section order: Install, Required IAM, Usage, Deploy, Configuration, Multiple instances, Events, Provisioning, Failure handling, Migrating from the extension, Differences from the extension (including a Region subsection), API surface, Reporting bugs, License.

Sections this README is missing:

  • Failure handling: what happens when a run fails, and how to find out.
  • Migrating from the extension: firebase ext:migrate and firebase ext:export --mode functions.
  • Provisioning: only if it applies to this kit.

The Differences section has seven subsections, with Region in the middle. Fold BUCKET_REGION decides where the function runs into the Region subsection.

When

Wait until the PRs that edit this README have merged: #3285, #3287, #3289, #3306 and #3307. Then fold their content into the new structure rather than rewriting it.

Lenguaje dominante
TypeScript
Estrellas
979
Forks
434
Merge medio
7 d 21 min
PR fusionados (30 d)
20

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de firebase/extensions

Todos los issues de firebase/extensions

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.