Bitbucket-Integration
Sie können Inhalte direkt von Paligo in die Bitbucket Cloud hochladen. Richten Sie die Paligo-to-Bitbucket-Integration so ein, dass Paligo sich mit Bitbucket verbinden kann und Sie dann veröffentlichen können.
Paligo unterstützt Bitbucket Cloud mit Continuous Integration (CI). Das bedeutet, dass Sie Inhalte in Paligo erstellen können, z. B. PDFs oder ein HTML-Helpcenter, und diese in Bitbucket Cloud veröffentlichen. Wenn der Inhalt in Bitbucket hochgeladen wird, können Sie ihn entpacken (automatisch, wenn Sie dies wünschen), um ihn sofort live für Ihre Endbenutzer verfügbar zu machen.
Anmerkung
Paligo verfügt nicht über eine direkte Integration mit dem Bitbucket-Server. Mit unserer API können Ihre Entwickler jedoch selbst eine Bitbucket-Server-Integration einrichten.
Bevor Sie von Paligo in Bitbucket veröffentlichen können, benötigen Sie:
-
Ein Bitbucket Cloud-Konto
-
Grundlegende Bitbucket-Kenntnisse und -Fähigkeiten, einschließlich der Erstellung eines Repositorys
-
Ein Repository in Bitbucket. Paligo lädt die veröffentlichte Ausgabe zum Repository hoch. Die Ausgabe wird als ZIP-Datei hochgeladen.
So richten Sie Paligo für die Publikation in der Bitbucket Cloud ein:
So kann Paligo Ihre Ausgabe als ZIP-Datei zu dem von Ihnen gewählten Repository veröffentlichen. Sie können die Datei manuell entpacken oder Bitbucket-Pipelines so einrichten, dass die Inhaltsdatei automatisch entpackt wird.
Um Paligo für die Verbindung mit Bitbucket Cloud einzurichten, benötigen Sie:
-
Ein Bitbucket Cloud-Konto.
-
Ein Repository, das die gepackten Inhalte aufnimmt, die Paligo bei der Veröffentlichung hochlädt.
Paligo kann Inhalte in das Stammverzeichnis eines Repositorys oder in einen Ordner innerhalb des Repositorys hochladen. Es kann auch in eine bestimmte Verzweigung hochgeladen werden.
-
Ein App-Passwort, das Schreibrechte für das Repository gewährt. Informationen zum Erstellen von App-Passwörtern in Bitbucket finden Sie unter App-Passwörter
Wenn Sie ein Repository eingerichtet haben, können Sie Paligo mit Bitbucket Cloud verbinden:
-
Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.
-
Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.
-
Wählen Sie den Avatar in der oberen rechten Ecke aus.
-
Wählen Sie im Menü Einstellungen aus.
-
Wählen Sie die Registerkarte Integrationen.
-
Suchen Sie die Einstellungen Bitbucket und wählen Sie Hinzufügen.
Anmerkung
Hinzufügen ist nur beim ersten Einrichten einer Integration verfügbar. Danach wird Hinzufügen durch Ändern ersetzt.
Paligo zeigt die Bitbucket-Integrationseinstellungen an:
-
Geben Sie die Workspace-ID ein. Der Workspace ist der Ort, an dem Sie Ihre Repositorys in Bitbucket erstellen.
Weitere Informationen über Bitbucket-Workspaces finden Sie unter Workspaces.
Anmerkung
Wenn die Workspace-ID mit dem Benutzernamen identisch ist, lassen Sie das Feld Workspace leer.
-
Geben Sie den Benutzernamen für das Bitbucket-Konto ein. Paligo verwendet dies, um sich bei BitBucket anzumelden. Es ist wichtig, dass das Konto Schreibrechte für das Repository hat (diese werden für das Konto in BitBucket festgelegt).
-
Geben Sie das App-Passwort ein. Dies ist das Passwort für den Zugriff auf die App in Bitbucket (und wird in Bitbucket definiert).
-
Geben Sie den Namen des Repository-Slug ein. Dies ist die URL für Ihr Repository und wird automatisch von Bitbucket generiert.
Um mehr über Bitbucket-Slugs zu erfahren, siehe Was ist ein Slug?
-
Wählen Sie die Verzweigung aus, in die Paligo Inhalte hochladen soll.
Wenn das Feld „Verzweigung“ leer ist (oder wenn eine Verzweigung fehlt), wählen Sie die Schaltfläche „Verzweigung“, um die Verzweigungen zu laden. Wählen Sie dann den Zweig aus der Dropdown-Liste aus.
Anmerkung
Wenn die Integrationseinstellung beim Hinzufügen neuer Verzweigungen geöffnet ist, erscheinen diese neuen Verzweigungen nicht im Feld Verzweigung, es sei denn, die Einstellung wird neu geladen.
Wählen Sie die Schaltfläche „Verzweigung“ aus, um die Integrationseinstellungen mit den neuesten Zweiginformationen zu aktualisieren.
-
Geben Sie als Zielordner den Verzeichnispfad für den Ordner ein, in den Paligo Inhalte hochladen soll.
Wenn Sie die Zip-Datei direkt in das Stammverzeichnis hochladen möchten, lassen Sie dieses Feld unausgefüllt.
-
Legen Sie mithilfe von Einen nicht eindeutigen Dateinamen verwenden fest, wie Paligo die Zip-Datei der Ausgabe benennen soll. Damit wird gesteuert, wie die Datei im Repository gespeichert wird.
-
Aktivieren Sie das Kontrollkästchen, um bei jeder Veröffentlichung einen einheitlichen Dateinamen für die Ausgabe-Zip-Datei zu verwenden. Enthält das Repository bereits eine Datei mit demselben Namen, wird die alte Datei mit der neuen überschrieben.
-
Deaktivieren Sie das Kontrollkästchen, um bei der Veröffentlichung jeder Ausgabe-Zip-Datei ein Nummernsuffix hinzuzufügen. Das Repository enthält Dateien für jede Ausgabe.
-
-
Drücken Sie Speichern.
-
Wählen Sie die Schaltfläche Ändern für die Integration aus.
-
Wählen Sie Testeinstellungen aus, um einen Verbindungstest durchzuführen.
-
Lautet Ihre Einstellung:
-
Richtig, zeigt Paligo eine grüne Erfolgsmeldung an.
-
Falsch, zeigt Paligo eine rote Fehlermeldung an.
Überprüfen Sie jede Verbindungseinstellung sorgfältig, um sicherzustellen, dass Sie keine Fehler gemacht haben, und versuchen Sie es erneut.
Wenn der Verbindungstest weiterhin fehlschlägt, wenden Sie sich an den Paligo-Support, um Unterstützung zu erhalten.
-
Wenn die Verbindung hergestellt ist, können Sie In BitBucket veröffentlichen.
Sie können Inhalte von Paligo in Bitbucket Cloud veröffentlichen, und der Prozess ähnelt dem „regulären“ Veröffentlichungsprozess sehr. Sie erstellen Ihre Publikation und Ihre Topics und richten ein Layout für den gewünschten Ausgabetyp ein, z. B. PDF, HTML5 usw. Anschließend wählen Sie die Veröffentlichungseinstellungen aus. Paligo erstellt dann eine Zip-Datei mit den Ausgabeinhalten. Die Zip-Datei wird in Ihren Browser heruntergeladen und auch in das von Ihnen gewählte Bitbucket-Repository hochgeladen.
Anmerkung
Sie können Bitbucket-Pipeline verwenden, um den Inhalt automatisch zu entpacken.
Um von Paligo in Bitbucket zu veröffentlichen, verwenden Sie die Option In Bitbucket hochladen in den Publikationseinstellungen. Diese Option ist nur verfügbar, wenn die Einstellungen für die Paligo Bitbucket-Integration vorhanden sind. Sie müssen auch eine Publikation und ein Layout einrichten, um die gewünschte Ausgabe zu erstellen, z. B. ein HTML5-Helpcenter. Damit können Sie von Paligo aus in Bitbucket veröffentlichen:
-
Wählen Sie das gepunktete Menü (...) für das Topic oder die Publikation im Content Manager aus.
-
Wählen Sie Veröffentlichen aus.
-
Wählen Sie den Ausgabetyp, den Sie veröffentlichen möchten (z. B. PDF, HTML, HTML5, Word, XML, eLearning, SCORM usw.).
-
Wählen Sie das Layout, das für Ihre Ausgabe verwendet werden soll.
-
Wählen Sie die zu veröffentlichenden Sprachversionen aus.
Anmerkung
Wenn keine Übersetzungen verfügbar sind, wird nur die Ausgangssprache angezeigt. Bei mehreren genehmigten Übersetzungen in verschiedene Sprachen können Sie auswählen, welche Sie mit aufnehmen möchten. Paligo veröffentlicht jede Sprachversion als separate Ausgabe.
Bei der PDF-Ausgabe können Sie sie als eine einzige, mehrsprachige Publikation veröffentlichen; aktivieren Sie hierzu das Kontrollkästchen Ausgewählte Sprachen kombinieren.
-
[en] If your content is set up to use Filterung/Profiling, use the Profiling attributes section to apply them. [Optional]. If you do not use filtering, ignore this setting.
[en] Select Edit and then choose the value for each filter that you want Paligo to use. For example, for Audience, choose Expert to include content that is marked as for expert users.
Wenn Sie keinen Filter anwenden möchten, lassen Sie das Feld leer.
Wählen Sie OK aus, um das/die gewählte(n) Profiling-Attribut(e) hinzuzufügen.
-
Aktivieren Sie im Abschnitt Ausgabe hochladen das Kontrollkästchen In Bitbucket hochladen.
Standardmäßig lädt Paligo die Ausgabe in das Repository und den Ordner hoch, die in den Einstellungen für die Paligo-zu-Bitbucket-Integration angegeben sind.
Sie können auch zu einem anderen Zweig und/oder Ordner veröffentlichen, wenn erforderlich. Wählen Sie das Symbol Bearbeiten neben In Bitbucket hochladen und wählen Sie dann die Verzweigung und/oder den Ordner im Dialogfeld „Bearbeiten“ aus. Die von Ihnen ausgewählten Einstellungen werden nur für diesen einzelnen Veröffentlichungsprozess verwendet. Bei jeder zukünftigen Veröffentlichung werden die in den Integrationseinstellungen definierten Zweige und Ordner wiederverwendet.
-
Im Abschnitt Ausgabedateiname können Sie den Dateinamen verwalten.
Standardmäßig verwendet Paligo die in den Systemeinstellungen festgelegte Dateinamensyntax.
Um die im Dateinamen enthaltenen Angaben zu ändern, geben Sie Ihr gewünschtes Format in den Publikationseinstellungen ein. Die Standardeinstellung lautet:
ID-Title-Format
.Sie können folgende Angaben in den Namen aufnehmen:
-
ID - Die ID des Dokuments.
-
Titel - Der Titel der Publikation oder des Topics, das Sie veröffentlichen.
-
Format - Der Name des Ausgabeformats, zum Beispiel PDF oder HTML5.
-
Bearbeitungsdatum - Das Datum, an dem die Publikation oder das Topic zuletzt bearbeitet wurde.
-
Label der Verzweigung – Der Text aus dem Label der Verzweigung für die Publikation oder das Topic. Dies gilt nur, wenn Ihre Inhalte verzweigt wurden und die Verzweigung über ein Label verfügt. Details hierzu finden Sie unter Beschriftungen für Zweige hinzufügen oder bearbeiten.
-
Eindeutiger Wert - Eine von Paligo generierte zufällige Zeichenfolge, die dem Dateinamen hinzugefügt wird, um ihn einzigartig zu machen. Dadurch kann verhindert werden, dass die Datei durch spätere Veröffentlichungen desselben Dokuments überschrieben wird.
Tipp
Wenn Sie @ in das Feld eingeben, zeigt Paligo eine Liste der verfügbaren Werte an, aus denen Sie wählen können. Um einen Wert zu entfernen, klicken Sie ihn an und verwenden Sie die Löschtaste oder Rücktaste, um alle Zeichen zu entfernen.
Anmerkung
Der in der oberen rechten Ecke angezeigte Dateiname ist eine Vorschau auf den Dateinamen, den Paligo bei der Veröffentlichung verwendet.
-
-
Legen Sie die optionalen Parameter fest (lassen Sie das Kontrollkästchen deaktiviert, wenn Sie diese Funktionen nicht wünschen):
-
Speichern Sie die Ausgabe in Paligo - Aktivieren Sie das Kontrollkästchen, um die Zip-Datei in der Ressourcenübersicht zu speichern. Deaktivieren Sie das Kontrollkästchen, wenn Paligo nur die veröffentlichte Ausgabedatei in Ihrem Browser herunterladen soll.
-
E-Mail an mich - Aktivieren Sie dieses Kontrollkästchen, wenn Paligo Ihnen eine E-Mail schicken soll, wenn die Publikation bereit ist. Dies ist bei sehr großen Publikationen von Vorteil, deren Verarbeitung und Veröffentlichung länger dauern können.
-
Debug-Build erstellen - Aktivieren Sie dieses Kontrollkästchen, wenn Paligo eine Protokolldatei und einen Link-Bericht einfügen soll. Wenn Ihre Inhalte ein Problem verursachen, kann der Paligo Support Sie bitten, diese Funktion zu aktivieren, damit er die Protokolldateien zur Ermittlung der Ursache nutzen kann.
-
-
Wählen Sie Dokument veröffentlichen aus.
Paligo beginnt mit der Verarbeitung Ihrer Inhalte und wendet Ihre Layout- und Publikationseinstellungen an. Die benötigte Zeit ist von dem Umfang der Inhalte abhängig, die Sie veröffentlichen (je mehr Inhalte, desto länger dauert der Vorgang).
Die veröffentlichte Ausgabe erscheint wie folgt:
-
Eine Zip-Datei mit der veröffentlichten Ausgabe erscheint im Ordner Downloads auf Ihrem Computer.
Wenn Sie die Einstellungen Ihres Browsers geändert haben, um heruntergeladene Dateien an einem anderen Ort zu speichern, befindet sich die Zip-Datei stattdessen dort.
Wenn Sie eine Publishing-Integration verwenden, wird die Zip-Datei auch an den entsprechenden Dienst gesendet.
-
Ein Link im Panel Aktivitätsfeed zum Herunterladen der veröffentlichten Inhalte.
Anmerkung
Um die Inhalte online zur Verfügung zu stellen, entpacken Sie zunächst die Datei. Sie können die Datei dann lokal verwenden oder einen FTP-Client wie Filezilla verwenden, um den entpackten Inhalt auf einen Webserver hochzuladen.
Tipp
Sie können Ihre Publikationseinstellungen speichern und wiederverwenden, um einen reibungsloseren Publikationsprozess zu erreichen, siehe Publikationseinstellungen. Alle gespeicherten Einstellungen können auch für [en] Batch Publishing verwendet werden.
-
Anmerkung
Dieser Inhalt richtet sich an Entwickler, die Bitbucket verstehen und wissen, wie man SSH-Schlüssel und Bitbucket-Pipelines erstellt.
Wenn Sie von Paligo in Bitbucket Cloud veröffentlichen, lädt Paligo den Inhalt als ZIP-Datei hoch. Um den Paligo-Inhalt zu verwenden, müssen Sie ihn in Bitbucket entpacken, indem Sie Bitbucket-Pipelines verwenden. Hierzu gehört unter anderem:
-
Erzeugen von SSH-Schlüsseln für Bitbucket-Pipelines
-
Hinzufügen einer bitbucket-pipelines.yml-Datei im Stammverzeichnis Ihres Repositorys.
Hierzu führen Sie folgende Aktionen aus:
-
Melden Sie sich bei Ihrem Bitbucket-Konto an und wählen Sie das Repository aus, das Sie für die Veröffentlichung von Inhalten aus Paligo verwenden werden.
-
Wählen Sie im seitlichen Menü Repository-Einstellungen aus.
-
Scrollen Sie in Repository-Einstellungen nach unten zum Abschnitt Pipelines und wählen Sie SSH-Schlüssel aus.
-
Wählen Sie Schlüssel erzeugen, um einen privaten und einen öffentlichen Schlüssel zu erstellen.
-
Kopieren Sie den öffentlichen Schlüssel.
-
Wählen Sie Ihr Profil und Ihre Einstellungen aus.
-
Wählen Sie im Menü Persönliche Einstellungen, um das Fenster „Persönliche Einstellungen“ anzuzeigen.
-
Wählen Sie SSH-Schlüssel aus.
-
Wählen Sie Schlüssel hinzufügen aus und fügen Sie dann den öffentlichen Schlüssel ein, den Sie in Schritt 5 kopiert haben.
Bitbucket sendet Ihnen eine E-Mail, um Sie darüber zu informieren, dass Sie einen Schlüssel zu Ihrem Repository hinzugefügt haben.
-
Erstellen Sie die Datei
bitbucket-pipelines.yml
im Stammverzeichnis Ihres Repositorys. -
Bearbeiten Sie die Datei
bitbucket-pipelines.yml
so, dass sie den Inhalt entpackt, den Paligo zum Repository hochlädt. Wir haben Beispiele für verschiedene Szenarien bereitgestellt, die Sie als Ausgangspunkt verwenden können.
Anmerkung
Bitte verwenden Sie die folgenden Beispiele auf eigenes Risiko. Sie sollten den Zweck des Beispiels und der Schritte verstehen können. Bei Problemen können wir leider keinen Support leisten. Betrachten Sie die Beispiele als Konzeptnachweis.
image: php:7.2 pipelines: default: - step: script: - TARGET_BRANCH=$BITBUCKET_BRANCH 1 - DESTINATION_FOLDER="." 2 - apt-get update && apt-get install -y unzip git - cd $DESTINATION_FOLDER - FILE_COUNT=$(find ./ -name "*.zip" | wc -l) - if [[ $FILE_COUNT -gt 0 ]]; then - find ./ -name "*.zip" -exec unzip -o {} \; - rm *.zip - git add . - git commit -m "unzip the file from paligo and remove the zip file" - git push origin $TARGET_BRANCH - fi
TARGET_BRANCH – Der Name des Zweigs, in den Inhalt entpackt wird. In diesem Beispiel verwenden wir die von Bitbucket bereitgestellte Umgebungsvariable |
|
DESTINATION_FOLDER – Wenn Sie den Zielordner in den Bitbucket-Integrationseinstellungen von Paligo ändern, müssen Sie diesen Ordner hier angeben. Beachten Sie, dass Sie einen relativen Pfad angeben müssen. Wenn Sie beispielsweise
|
-
Es sucht alle Dateien mit der Endung
.zip
und entpackt sie im aktuellen Ordner. -
Es entfernt alle Dateien mit der Endung
.zip
und verschiebt Änderungen zurück in den aktuellen Zweig.
image: php:7.2 pipelines: default: - step: script: - TARGET_BRANCH="paligo-output" 1 - DESTINATION_FOLDER="." 2 - apt-get update && apt-get install -y unzip git - cd $DESTINATION_FOLDER - FILE_COUNT=$(find ./ -name "*.zip" | wc -l) - if [[ $FILE_COUNT -gt 0 ]]; then - TMP_DIR=$(mktemp -d -t paligo-XXXXXXXXXX) - find ./ -name "*.zip" -exec unzip -d $TMP_DIR -o {} \; - rm *.zip - git add . - git commit -m "remove the zip file" - git push origin $BITBUCKET_BRANCH - sleep 1 - git checkout -b $TARGET_BRANCH && git pull - cp --recursive --force $TMP_DIR/* ./ - git add . - git commit -m "unzip the file from paligo" - git push -f origin $TARGET_BRANCH - fi
TARGET_BRANCH – Der Name des Zweigs, in den Inhalt entpackt wird. In diesem Beispiel verwenden wir den Zweignamen paligo- |
|
DESTINATION_FOLDER – Wenn Sie den Zielordner in den Bitbucket-Integrationseinstellungen von Paligo ändern, müssen Sie diesen Ordner hier angeben. Beachten Sie, dass Sie einen relativen Pfad angeben müssen. Wenn Sie beispielsweise
|
-
Es findet alle Dateien mit der Endung
.zip
und entpackt sie in einen temporären Ordner. -
Es entfernt alle Dateien mit der Endung
.zip
und verschiebt Löschungen zurück in den aktuellen Zweig. -
Es ändert den Zweig.
-
Es kopiert alle Dateien aus dem temporären Ordner in den Zweigordner.
-
Es übergibt Dateien.
image: php:7.2 pipelines: default: - step: script: - DESTINATION_FOLDER="." - TARGET_REPOSITORY="paligo-publications" - TARGET_BRANCH="output" - BITBUCKET_NAME='John Doe' - BITBUCKET_USERNAME='johndoe' - BITBUCKET_USEREMAIL='john.doe@company.com' - apt-get update && apt-get install -y unzip git - cd $DESTINATION_FOLDER - FILE_COUNT=$(find ./ -name "*.zip" | wc -l) - if [[ $FILE_COUNT -gt 0 ]]; then - TMP_DIR=$(mktemp -d -t paligo-XXXXXXXXXX) - find ./ -name "*.zip" -exec unzip -d $TMP_DIR -o {} \; - rm *.zip - git add . - git commit -m "remove the zip file" - git push origin $BITBUCKET_BRANCH - sleep 1 - CLONE_DIR=$(mktemp -d -t clone-XXXXXXXXXX) - cd $CLONE_DIR - git clone git@bitbucket.org:$BITBUCKET_USERNAME/$TARGET_REPOSITORY.git $CLONE_DIR - git checkout -b $TARGET_BRANCH - cp --recursive --force $TMP_DIR/* ./ - git config --global user.email "$BITBUCKET_USEREMAIL" - git config --global user.name "$BITBUCKET_NAME" - git add . - git commit -m "unzip the file from paligo and remove the zip file" - git push -f origin $TARGET_BRANCH - fi
-
Es findet alle Dateien mit der Endung
.zip
und entpackt sie in einen temporären Ordner. -
Es entfernt alle Dateien mit der Endung
.zip
und verschiebt Löschungen zurück in den aktuellen Zweig. -
Es erstellt einen neuen temporären Ordner und klont das Ziel-Repository in diesen Ordner.
-
Es kopiert alle Dateien aus dem temporären Ordner in den Zweigordner.
-
Es übergibt Dateien.