Welcome to EntX Documentation Platform, a managed documentation solution powered by Wiki.js. Designed for seamless content creation, organization, and collaboration, EntX Documentation Platform provides a modern and feature-rich environment for managing documentation at any scale. This guide will walk you through all aspects of using and managing documentation effectively on this platform, available at https://documentation.entx.org.
EntX Documentation Platform, powered by Wiki.js, offers a flexible and secure documentation management system that enables users to create, edit, and publish content collaboratively. With robust features like version control, integrated search, permissions management, and support for multiple content formats, the platform is ideal for creating anything from simple guides to complex knowledge bases.
¶ 1. Content Creation and Editing
Write and format content with ease, using a rich text editor or Markdown for advanced users.
- Markdown and WYSIWYG Support: Create content with either Markdown or a What-You-See-Is-What-You-Get (WYSIWYG) editor.
- Real-Time Collaborative Editing: Work on documents simultaneously with other team members.
- Content Templates: Save time with pre-made templates for standardized documentation.
¶ 2. Organization and Structure
Organize documentation into a logical structure, making it easy to navigate and find relevant content.
- Categories and Tags: Classify pages with categories and tags for streamlined organization.
- Sidebar Navigation: Create a hierarchical sidebar for easy browsing through sections and subsections.
- Content Trees: Visualize the structure of your documentation for efficient planning and management.
¶ 3. Version Control and History
Track every change with built-in version control to ensure data integrity and accountability.
- Automatic Versioning: Every edit is saved as a new version, allowing you to revert to previous states.
- Change History: View a complete history of modifications, including who made each change.
- Rollback Options: Easily revert to earlier versions if needed.
¶ 4. Advanced Search and Indexing
Quickly locate information across large documentation sets.
- Full-Text Search: Search across all content, including titles, tags, and page content.
- Filtering and Sorting: Use filters by category, tag, or metadata to narrow down search results.
- Real-Time Indexing: New content is indexed in real-time, ensuring search accuracy and speed.
¶ 5. Customizable Permissions and Access Control
Control who can view, edit, or manage documentation with granular permissions.
- Role-Based Access Control (RBAC): Assign roles with specific permissions to users or groups.
- Public and Private Access: Set pages or entire sections as public or restrict them to specific users.
- Guest Access Options: Allow read-only access for non-registered users on selected content.
Localize your documentation for different audiences with language management tools.
- Language Management: Publish documentation in multiple languages and manage translations.
- Automatic Language Detection: Direct users to the appropriate language version based on browser settings.
¶ 7. Theming and Customization
Tailor the look and feel of your documentation to match your brand identity.
- Custom Themes: Choose from a variety of pre-built themes or design custom themes.
- Customizable Layouts: Control the structure and presentation of your documentation.
- Custom CSS and JavaScript: Enhance pages with custom styling or scripts for added functionality.
¶ 8. Integrations and Embeds
Extend functionality with third-party integrations and embed rich content.
- Embed Media and External Content: Add videos, images, iframes, and external links directly into pages.
- Git and GitHub Sync: Sync documentation with Git repositories for backup or code documentation.
- API Integration: Use the Wiki.js API to automate content creation and management.
- Navigate to: https://documentation.entx.org
- Log In: Use your EntX credentials to log in.
- Dashboard Access: Once logged in, access the dashboard to start creating and organizing your documentation.
- Supported Browsers: Chrome, Firefox, Safari, and Edge (latest versions).
- User Permissions: Access to specific features may vary based on your assigned role.
¶ Creating and Editing Content
- Create New Page: Click "New Page" from the dashboard.
- Choose an Editor: Select between Markdown or WYSIWYG editor.
- Add Content: Use the editor toolbar to format text, add images, tables, and more.
- Select Template: From the page editor, choose "Templates" to apply a pre-made format.
- Customize: Modify the template as needed to fit your content requirements.
- Insert Media: Use the "Insert Media" button to add images, videos, or other files.
- Embed Code: Paste embed codes from external sites like YouTube, Vimeo, or social media.
For advanced users, Markdown provides a powerful way to create structured, clean documents.
- Basic Markdown: Use
# for headings, * for lists, and []() for links.
- Advanced Markdown: Leverage tables, code blocks, and inline HTML for complex formatting.
- Create Categories: Go to "Settings > Categories" to organize documentation by topic.
- Add Tags: In the page editor, add tags to make pages easier to find.
¶ Sidebar and Content Trees
- Custom Sidebar: Organize pages in the sidebar using drag-and-drop to create a logical hierarchy.
- Content Trees: Visualize your documentation structure for improved navigation and management.
- Internal Links: Use
[Link Text](Page URL) to create links to other pages within your documentation.
- External Links: Add full URLs for links to outside resources.
¶ Collaboration and Version Control
Collaborate on content with others in real time, with visible indicators showing who is editing each section.
- Access Version History: Click on "Page History" in the editor.
- View Changes: See who made edits, with a timestamp for each version.
- Revert Versions: Select a previous version and revert if needed.
¶ User Roles and Permissions
- Admin Panel: Go to "Settings > Users" to assign roles.
- Role Options: Choose from Viewer, Editor, Admin, and Custom Roles.
- Custom Roles: Create custom roles for specific permissions based on organizational needs.
- Public/Private Pages: Define access at the page level, setting it as public or private.
- Group Permissions: Set permissions for specific user groups to view or edit content.
- Enable Language Options: Go to "Settings > Localization" to enable multiple languages.
- Add Translations: Each page has an option to add translated content.
- Automatic Language Detection: Users are directed to their language version based on their browser’s language setting.
¶ Customizing the Look and Feel
- Choose a Theme: Go to "Settings > Themes" and select from available options.
- Custom Themes: Upload or create custom themes to match your branding.
- Custom CSS: Add custom styles in "Settings > Appearance > Custom CSS."
- JavaScript: Add scripts for additional interactivity in "Settings > Custom JavaScript."
Sync documentation with a Git repository for version control or backup.
- Enable Git Sync: In "Settings > Git Sync," connect to a GitHub, GitLab, or custom Git repository.
- Automatic Syncing: Configure push and pull settings to sync changes automatically.
Automate documentation management with the Wiki.js API.
- API Keys: Generate API keys in "Settings > API Access."
- Documentation: Refer to API documentation for details on endpoints and usage.
¶ Troubleshooting and Support
- Login Errors: Clear your browser cache or try a different supported browser.
- Permission Denied: Ensure you have the required role to access restricted pages.
- Sync Issues: Check Git repository settings and permissions if you encounter sync errors.
- Knowledge Base: Access tutorials, FAQs, and troubleshooting guides in the Help section.
- Community Forum: Engage with other EntX Documentation Platform users for tips and best practices.
- Customer Support: Contact EntX support via the portal for technical assistance.
Q: Can I use both Markdown and WYSIWYG editors?
A: Yes, you can switch between Markdown and WYSIWYG editors to suit your needs.
Q: How do I control access to specific pages?
A: Use the permissions settings in each page’s options to restrict or grant access based on user roles.
Q: Can I revert to an older version of a page?
A: Yes, EntX Documentation Platform supports full version history, allowing you to revert to previous versions.
Q: Is my data secure on EntX Documentation Platform?
A: Absolutely. The platform uses SSL encryption and supports role-based access control to ensure data security.
For the latest updates, features, and improvements, visit the Changelog section in the EntX Documentation Platform on the EntX Wiki.
The EntX Documentation Platform, powered by Wiki.js, is your all-in-one solution for managing knowledge and documentation. For additional help, visit the Help section in the EntX portal or reach out to EntX Support. Happy documenting!