Anpassen des Eintrags im softwareverzeichnis

Auf dieser Seite erhalten Sie einen kurzen Überblick darüber, wie Ihr Projekt im softwareverzeichnis angezeigt wird und Sie dies am Besten anpassen können. Dafür ist vor allem Ihre publiccode.yml-Datei von Bedeutung.

Die folgende Abbildung zeigt die Detailseite eines Eintrags im softwareverzeichnis. Dabei sind die Einträge auf der Seite den entsprechenden Schlüsseln aus der publiccode.yml-Datei zugeordnet worden.

"Visualisierung der Werte aus der publiccode.yml im softwareverzeichnis

Häufig gestelle Fragen und Probleme

Wie füge ich eine Beschreibung hinzu?

Unter der Kategorie description können einfache Markdown-Elemente verwendet werden, um die Formatierung der Beschreibung Ihres Projektes Ihren Wünschen anzupassen. So kann ein Beschreibung (longDescription) zum Beispiel wie folgt aussehen:

Das obige Beispiel illustriert auch die verschiedenen Markdown-Gestaltungselemente, die Sie für eine Beschreibung nutzen können.

Diese Beschreibung sieht im softwareverzeichnis dann wie folgt aus:

Screenshot des obigen Beispiels einer Beschreibung im softwareverzeichnis

Wie kann ich meine Software einer Software-Suite zuordnen?

In der publiccode.yml kann mit dem Schlüssel softwareSuite die eigene Software einer Software-Suite zugeordnet werden. Dieser ordnet den Eintrag im softwareverzeichnis einem übergeordneten Projekt zu:

![Screenshot des Eintrags im softwareverzeichnis von einer Softwaresuite](/../assets/images/softwareverzeichnis/Screenshot-Eintrag-Software-Suite.png "Screenshot, welcher einen Ausschnitt aus dem Eintrag des softwareverzeichnisses der Software openDesk zeigt. In dem Ausschnitt sieht man die Tabs "Aktive Nutzung", "Teilprojekte" und den Hinweis, "Die Suite openDesk besteht aus verschiedenen Teilprojekten")

Wie füge ich Badges hinzu?

Ihr Projekt kann, wenn es die nötigen Voraussetzungen erfüllt, mit verschiedenen Badges ausgezeichnet werden. Diese zeigen den Status des Projektes im Bezug auf Sicherheit, Wartung und Nachnutzung. In der Dokumentation der Badges finden Sie genauere Informationen zu den Voraussetzungen der einzelnen Badges und wie Sie diese erhalten.

Wie reiche ich eine Nachnutzung ein?

Zum Einreichen eines Nachnutzungsrechts Ihrer Software müssen Sie diesen Schritten folgen:

  1. Klicken Sie zuerst auf der Seite Nutzung sichtbar machen auf Nachnutzung einreichen. Sie werden nun auf die Suche von openCode weitergeleitet.
  2. Öffnen Sie hier nun den Eintrag des Projekts, welcher Ihrem Suchbegriff entspricht.
  3. Nach einem Klicken auf Nachnutzung einreichen wird das Formular zur endgültigen Bestätigung der entsprechenden Nachnutzung geöffnet.

Nachdem Sie dieses Formular ausgefüllt und abgeschickt haben, haben Sie die Nachnutzung erfolgreich eingereicht.

Warum wird mein Projekt nicht im openCode softwareverzeichnis angezeigt?

Dies liegt vermutlich daran, dass Ihre publiccode.yml-Datei fehlerhaft ist oder Einträge in Ihrer publiccode.yml-Datei vergessen wurden. Eine Anleitung zum Erstellen der publiccode.yml finden Sie hier im Guide.