mirror of
https://github.com/StarFleetCPTN/GoMFT.git
synced 2026-09-11 09:00:49 +02:00
StarFleetCPTN
834f066704
- Added Docusaurus configuration and initial setup for documentation. - Created multiple documentation pages covering installation, configuration, and core concepts. - Implemented a GitHub Actions workflow for automatic deployment of documentation to GitHub Pages. - Updated .gitignore to exclude Docusaurus build artifacts and dependencies. - Enhanced README with a link to the online documentation.
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# GoMFT Documentation Images
|
|
|
|
This directory contains images used in the GoMFT documentation.
|
|
|
|
## Required Images
|
|
|
|
The following images are used in the documentation:
|
|
|
|
- `logo.svg` - The GoMFT logo for the header
|
|
- `favicon.ico` - The website favicon
|
|
- `docusaurus-social-card.jpg` - Social media preview image
|
|
- `dashboard.gomft.png` - Screenshot of the GoMFT dashboard
|
|
- `dashboard.dark.gomft.png` - Screenshot of the GoMFT dashboard in dark mode
|
|
- `transfer.config.gomft.png` - Screenshot of the transfer configuration
|
|
- `scheduled.jobs.gomft.png` - Screenshot of the scheduled jobs
|
|
- `transfer.history.gomft.png` - Screenshot of the transfer history
|
|
- `user.management.gomft.png` - Screenshot of the user management
|
|
- `role.management.gomft.png` - Screenshot of the role management
|
|
- `authentication.providers.gomft.png` - Screenshot of the authentication providers
|
|
- `notifications.gomft.png` - Screenshot of the notifications
|
|
- `notification.service.gomft.png` - Screenshot of the notification service
|
|
- `audit.logs.gomft.png` - Screenshot of the audit logs
|
|
- `file.details.gomft.png` - Screenshot of the file details
|
|
- `file.metadata.gomft.png` - Screenshot of the file metadata
|
|
- `database.tools.gomft.png` - Screenshot of the database tools
|
|
- `job.run.details.gomft.png` - Screenshot of the job run details
|
|
|
|
## Symlinks for Backward Compatibility
|
|
|
|
- `dashboard.png` → `dashboard.gomft.png`
|
|
- `create-transfer.png` → `transfer.config.gomft.png`
|
|
- `docker.png` - Placeholder for Docker-related screenshots
|
|
|
|
## Adding New Images
|
|
|
|
When adding images to this directory:
|
|
|
|
1. Use descriptive filenames
|
|
2. Optimize image size when possible
|
|
3. Use PNG for screenshots and SVG for vector graphics
|
|
4. Include alt text when referencing images in documentation |