Documentation for major implementation featuresets.

Abierto
  • ¿Algo no está bien?
#119 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza revisando la documentación existente de alto nivel de dripline y las clases implementadas actualmente, especialmente su comportamiento de ethernet, alerts/logging, RPC y scripting. Se considerará terminado cuando se haya añadido orientación para las cuatro áreas indicadas que distinga el comportamiento intrínseco de dripline del comportamiento específico de la implementación, explique los límites de extensión y documente las precauciones relevantes.

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

Descripción

documentation

It can be difficult for a user to understand how to make a connection between abstract and high-level discussion of how dripline works and practical understanding of how to start operating equipment. In particular, some patterns/features/choices are intrinsic aspects of dripline, while others just happen to be true for the classes that are already implemented. The following documentation additions would hopefully help with this (possibly to be broken out into their own issues depending on when they are worked on):

  • Discussion of ethernet support and assumptions. In particular, some discussion of various standard that we at least partly touch. Also the assumptions the existing classes make about what the interactions with a device should look like, and where it may or may not make sense to push those boundaries for other devices.

  • Expansion of the "alerts"/"logging" (as in to a database) system. Similar to above for network communication, really focusing on the delineation of things that are true about logging in dripline always vs the things that are true for the classes that are available "out of the box" for use. Also similar, discuss both where small extensions may be valuable and when fully new implementations are probably required. Also include some digression into what a reasonable storage backend may look like (and be clear that it is digression).

  • Discussion of how to bolt on fully brute force capabilities and use dripline for more-or-less arbitrary RPC to python-implemented systems. Should note both how powerfully this will let you just get something running but also caution about both fragility and technical debt that come along with doing this.

  • Discussion of scripting pattern and recommendation about how to go about adding high-level/complex-logic/synchronous tasking to an existing mesh.

Lenguaje dominante
Python
Estrellas
3
Forks
6
Sin PR fusionados en 30 d

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 driplineorg/dripline-python

Todos los issues de driplineorg/dripline-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.