Review all front-end-related documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 30/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- graphql, javascript, react, redux
- Área
- documentation, frontend
Línea de trabajo
Start by reviewing the front-end documentation linked in the issue, especially the React injector material, the React API and major release policy references, and the GraphQL JavaScript documentation. Check issues 41 and 62 and pull request 215 for existing context. Done means the outdated or misleading guidance is corrected and the front-end documentation has a clearer structure with separate API and step-by-step guidance.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Our front-end documentation is fractured, outdated, and in some cases potentially misleading. It could do with a review.
Some things to consider:
- https://docs.silverstripe.org/en/4/developer_guides/customising_the_admin_interface/reactjs_redux_and_graphql/#introduction-to-the-react-layer says the react API isn't part of our semver commitment, but that seems to be the only place that mentions it. It certainly isn't mentioned in our major release policy, which is the place where most people will look for that sort of information.
- It would be nice if there was a clearer structure to the doc - currently it seems to find information about javascript development in the CMS we have to traverse all over the place. These should be collected in a single section, ideally (see https://github.com/silverstripe/developer-docs/issues/41)
- In particular, the react injector documentation is very difficult to parse. It needs to be split into multiple pages. At the very least, there should be one page that focuses on the API of the react injector, and another that provides concrete step-by-step examples of how to use it in a specific narrow-scope project. At the moment those are mixed together, which ultimately means the step-by-step guide is hard to follow at best, and the documentation about the API isn't clear nor complete. See https://github.com/silverstripe/developer-docs/pull/215#issuecomment-1507784574
- A lot of our graphql js stuff is outdated (see https://github.com/silverstripe/developer-docs/issues/62)
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 7
- Forks
- 76
- Merge medio
- 1 d 12 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de silverstripe/developer-docs
-
6.0.0 changelog: DBField formatters on array getters now render emptyPosiblemente ocupada Un pull request vinculado a esta issue está abierto o ya se fusionó. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
silverstripe/developer-docs#912 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
silverstripe/developer-docs#911 ·
-
Read-only replicas: config key is rule_patterns_must_use_primary_db, not must_use_primary_db_rulesAbiertoaffects/v6 complexity/low impact/low type/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
silverstripe/developer-docs#909 · 1 comentario ·
-
affects/v6 complexity/low impact/low type/docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
silverstripe/developer-docs#908 · 1 comentario ·
-
affects/v5 affects/v6 complexity/low impact/low type/docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
silverstripe/developer-docs#907 · 1 comentario ·
Todos los issues de silverstripe/developer-docs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
EchoTools/nevr-runtime#264 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Automattic/data-liberation-agent#685 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 77/100
Crosstalk-Solutions/project-nomad#1427 ·
Los mantenedores suelen responder en 2 días
-
automated issue report
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 83/100
kubernetes-sigs/kueue#16990 ·
Los mantenedores suelen responder en 1 día