Minor clarifications for Integration API documentation (integration_port and Traefik config examples)

Offen
#70 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

Öffne die Dokumentation zur Integration API auf der verlinkten Seite und überprüfe die Beispiele für integration_port und Traefik YAML. Kläre, ob integration_port erforderlich ist oder standardmäßig auf 3003 gesetzt wird, erkläre die Verwendung von Anführungszeichen und berücksichtige den Hinweis zur Einrückung; als erledigt gilt die Aufgabe, wenn die Anleitung zur Einrichtung eindeutig ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

  1. 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.

  1. 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.

  1. 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.

  1. 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 👍

Vorherrschende Sprache
MDX
Sterne
14
Forks
55
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

  • Enthält ein Dockerfile oder eine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus fosrl/docs

Alle Issues in fosrl/docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.