Minor clarifications for Integration API documentation (integration_port and Traefik config examples)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Abre la documentación de Integration API en la página enlazada y revisa los ejemplos de integration_port y Traefik YAML. Aclara si integration_port es obligatorio o tiene 3003 como valor predeterminado, explica el uso de las comillas y considera la nota sobre la indentación; se considera terminado cuando las instrucciones de configuración sean inequívocas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Body
While setting up the Integration API following the documentation, I noticed a few small points that might benefit from clarification.
Documentation reference:
https://docs.pangolin.net/self-host/advanced/integration-api
- integration_port seems required
The documentation shows:
server:
integration_port: 3003 # Specify different port
The comment suggests that this only needs to be set when using a port different from 3003.
However, during setup the Integration API did not appear to start unless integration_port was explicitly defined. It might help to clarify whether:
this field is required, or
it is optional and defaults internally to 3003.
If it is required, the comment could be slightly misleading.
- Quotes in Traefik rule
The example uses:
rule: "Host(api.example.com)"
In YAML this also works without quotes:
rule: Host(api.example.com)
It might be worth mentioning whether the quotes are recommended or simply optional.
- Quotes in service URL
Similarly, the example shows:
servers:
- url: "http://pangolin:3003"
This usually works without quotes as well:
servers:
- url: http://pangolin:3003
Clarifying whether quotes are intentional or just stylistic could help avoid confusion.
- Minor YAML note (optional suggestion)
A small note reminding users that YAML is indentation-sensitive might help prevent copy/paste errors when applying the config snippets.
Thanks for the great project and documentation 👍
- Lenguaje dominante
- MDX
- Estrellas
- 14
- Forks
- 55
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Sin 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 fosrl/docs
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 55/100
-
docs(kubernetes): add --devel for Pangolin Helm pre-release installsPosiblemente ocupada @marcschaeferger la tomó hace 73 días. Abierto
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
-
Issue on docsAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
Todos los issues de fosrl/docs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
YahiaAngelo/vphone-linux#70 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
Los mantenedores suelen responder en 3 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
FuRongJun-1999/dsh-memory#1000 ·
Los mantenedores suelen responder en 1 día
-
curator: add zaherg/pi-sbxAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
ajeetraina/awesome-docker-sbx#561 ·
-
docs: reorder interface definition before fetch-libs and link PostgreSQL/library docs in tutorialAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
Los mantenedores suelen responder en 3 días