App Name
Dies ist das App-Dokumentationstemplate. Es enthält alle benötigten Dateien die für eine Microsoft Dynamics 365 Business Central Erweiterung vorhanden sein müssen.
Verwendung
Zum Hinzufügen einer App zur Dokumentation das Verzeichnis AppDocumentationTemplate
kopieren als AppName
und AppName
in apps/toc.yml
aufnehmen:
- name: Apps
items:
... weitere Apps ...
- name: App Name
href: AppName/toc.yml
... weitere Apps ...
- name: App Documentation Template
href: AppDocumentationTemplate/toc.yml
Die Dateiinhalte müssen nicht bearbeitet werden. Die Dokumentation der Apps erfolgt im Repository der jeweiligen App unter ./docs/* und werden beim Veröffentlichen automatisch diesem Repository hinzugefügt. Das vorherige Hinzufügen des Templates ist notwendig für eine fehlerfreie Erstellung der Dokumentation ohne fehlerhafte Links.
Werkzeuge
Das neue App-Verzeichnis kann erstellt werden mit PowerShell
.\New-DocsAppDoc.ps1 -AppRepositoryName AppName
Weitere Informationen
Für die relevanten app.json-Eigenschaften
"EULA": "https://docs.cloudservice.solutions/apps/AppDocumentationTemplate/eula",
"help": "https://docs.cloudservice.solutions/apps/AppDocumentationTemplate/help",
"url": "https://docs.cloudservice.solutions/apps/AppDocumentationTemplate",
"contextSensitiveHelpUrl": "https://docs.cloudservice.solutions/apps/AppDocumentationTemplate/pages/"
ist folgende Struktur in der Vorlage vorhanden
AppDocumentationTemplate
| index.md > https://docs.cloudservice.solutions/apps/AppDocumentationTemplate
| overview.md
| toc.yml
+---eula > https://docs.cloudservice.solutions/apps/AppDocumentationTemplate/eula
| index.md
+---help > https://docs.cloudservice.solutions/apps/AppDocumentationTemplate/help
| index.md
\---pages > https://docs.cloudservice.solutions/apps/AppDocumentationTemplate/pages
index.md