Tutorials
If you're looking for guidance on using this software, you're in the right place! Below, you'll find helpful resources, including videos and documentation, to assist both end-users and developers in understanding and working with the project.
Video Documentation
Explore video content related to this project, if this repository contains a _videos folder, be sure to check there for additional recordings.
| Description | Link |
|---|---|
| A playlist or video related to this project. | https://www.youtube.com/playlist?list=PL6npOHuBGrpAfrpUzQPTOWdqoCnhq1oP0 |
| If this repository contains a _videos folder, you can check that as well. |
GitHub Repositories
Here you can find GitHub repositories related to Suitefish-CMS, including the main project and resources for setup, development, and extensions.
| Description | Link |
|---|---|
| Suitefish-CMS | https://github.com/bugfishtm/suitefish-cms |
| Suitefish Official Module Library | https://github.com/bugfishtm/suitefish-modules |
| Suitefish Windows Software | https://github.com/bugfishtm/suitefish-windows |
| Bugfish Framework | https://github.com/bugfishtm/bugfish-framework |
Docker Documentation
Explore these curated links to guides, documentation, and community forums that will help you install, configure, and optimize your software within Docker containers. Whether you're new to Docker or an experienced user, these resources cover a wide range of tools and best practices.
| Description | Link |
|---|---|
| Developer Base Image | https://hub.docker.com/r/bugfishtm/sf-base |
| Suitefish on Docker | https://hub.docker.com/r/bugfishtm/suitefish |
Developer Resources
For developers looking to extend, customize, or integrate this software, the following resources provide essential documentation. This software is built on the Suitefish CMS platform, a powerful and flexible content management system. Learn how to configure, extend, and optimize it for your needs. At its core, this software leverages the Bugfish Framework, providing a robust foundation for scalability and performance - as a large function set. Documentation for the integrated default adminbsb theme can also be found here.
| Description | Link |
|---|---|
| CMS Developer Documentation | https://bugfishtm.github.io/suitefish-cms/ |
| Framework Developer Documentation | https://bugfishtm.github.io/bugfish-framework/ |
| AdminBSB Theme Developer Documentation | https://bugfishtm.github.io/suitefish-cms/extra-adminbsb/ |
Official Websites
For official documentation, updates, and direct support, be sure to visit our official websites. Here you'll find comprehensive guides, the latest news, and ways to connect with our team and community for any assistance you need.
| Description | Link |
|---|---|
| Bugfish (Creator) Website | https://bugfish.eu |
| Suitefish-CMS Store / Website | https://suitefish.com |
Offline Documentation
Offline documentation is sometimes included for use when you're not online. You’ll find links to the offline docs below, but please note they may only work if they are part of your release package.
| Description | Link |
|---|---|
| Bugfish Framework | ./extra-framework/index.html |
| AdminBSB Theme | ./extra-adminbsb/index.html |
| Suitefish-CMS | ./extra-cms/index.html |
Repository Structure
This table provides an overview of key files and folders related to the repository. Click on the links to access each file for more detailed information. If certain folders are missing from the repository, they are irrelevant to this project.
| Document Type | Description |
|---|---|
| .github | Folder with github setup files. |
| .github/CODE_OF_CONDUCT.md | The community guidelines. |
| _archive | Folder for archived files. |
| _changelogs | Folder for changelogs. |
| _developers | Folder with content for developers. |
| _docker | Folder to prepare docker images. |
| _images | Folder for project images. |
| _licenses | Folder for 3rd party licenses. |
| _packages | Folder for installable packages mostly for suitefish-cms. |
| _releases | Folder for releases. |
| _screenshots | Folder with project screenshots. |
| _scripts | Folder with additional scripts. |
| _source | Folder with the source code. |
| _videos | Folder with videos related to the project. |
| docs | Folder for the documentation. |
| .gitattributes | Repository setting file. Only for development purposes. |
| .gitignore | Repository ignore file. Only for development purposes. |
| README.md | Readme of this project. You are currently looking at this file. |
| repository_reset.bat | File to reset this repository. Only for development purposes. |
| repository_update.bat | File to update this repository. Only for development purposes. |
| CONTRIBUTING.md | Information for contributors. |
| CHANGELOG.md | Information about changelogs. |
| SECURITY.md | How to handle security issues. |
| LICENSE.md | License of this project. |
| MODULES.md | Reserved Module ID List. |