mirror of
https://github.com/StarFleetCPTN/GoMFT.git
synced 2026-09-08 15:41:20 +02:00
StarFleetCPTN
5f4db03982
- Enhanced the deployment workflow to ensure screenshots are copied to the correct static directory. - Added a new script to fix image paths in Markdown files for better compatibility with the updated structure. - Updated Docusaurus configuration to streamline static directory management and support image loading. - Adjusted documentation to reference the new image paths.
Images directory
This directory contains various images used throughout the documentation, including:
- Logo files
- Screenshots
- Icons and other assets
Some screenshots are automatically copied from the main repository's /screenshots directory during the build process.
The automated copy is handled by the prepare-screenshots script in package.json.
Required Images
The following images are used in the documentation:
logo.svg- The GoMFT logo for the headerfavicon.ico- The website favicondocusaurus-social-card.jpg- Social media preview imagedashboard.gomft.png- Screenshot of the GoMFT dashboarddashboard.dark.gomft.png- Screenshot of the GoMFT dashboard in dark modetransfer.config.gomft.png- Screenshot of the transfer configurationscheduled.jobs.gomft.png- Screenshot of the scheduled jobstransfer.history.gomft.png- Screenshot of the transfer historyuser.management.gomft.png- Screenshot of the user managementrole.management.gomft.png- Screenshot of the role managementauthentication.providers.gomft.png- Screenshot of the authentication providersnotifications.gomft.png- Screenshot of the notificationsnotification.service.gomft.png- Screenshot of the notification serviceaudit.logs.gomft.png- Screenshot of the audit logsfile.details.gomft.png- Screenshot of the file detailsfile.metadata.gomft.png- Screenshot of the file metadatadatabase.tools.gomft.png- Screenshot of the database toolsjob.run.details.gomft.png- Screenshot of the job run details
Symlinks for Backward Compatibility
dashboard.png→dashboard.gomft.pngcreate-transfer.png→transfer.config.gomft.pngdocker.png- Placeholder for Docker-related screenshots
Adding New Images
When adding images to this directory:
- Use descriptive filenames
- Optimize image size when possible
- Use PNG for screenshots and SVG for vector graphics
- Include alt text when referencing images in documentation