We are thrilled to announce that we have released the new documentation site for Corteza. The structure has been optimised and the content has been actualised. It now contains everything you need to know to install, set up and use the open-source digital work platform Corteza. The new structure also enables the community to contribute easier then ever before.
The documentation has the following structure:
The overview explains what Corteza is, and it gives a summary about the topics “Security”, “Architecture”, “Core Development”, “Deployment” and “Customization”. This chapter is recommended for all new Corteza users.
2. User Manual
The user manual has been created for people that use Corteza for their daily tasks, such as sales people, project managers, service agents, etc. It explains how “Corteza One”, the unified workspace, can be used to access applications and profile settings, and it goes in to details how to use “Corteza Messaging”, “Corteza CRM” and “Corteza Service Solution” are used.
3. Admin Manual
The admin manual is aimed at Corteza administrators, and explains how to manage an already installed instance of Corteza. The first part explains in depth features of the Corteza Admin Panel, and the second part is about Corteza Low-Code.
The chapter about Corteza Low-Code gives insights to admin users on how to create new business applications, and on how to modify already existing applications, such as Corteza CRM and Corteza Service Solution.
4. Management and Maintenance
Management and maintenance is the most technical manual, and it’s written for system administrators. It explains how to install and set up Corteza. Additionally, it gives an overview of the architecture, backup and restore methods, and technical requirements.
The technical requirements section is divided by client side (software) and server side (software, hardware, storage, network, domain and HTTPS/SSL Certificates).
5. Extending and Customising
Developers can learn here how to extend and customise Corteza. Automation scripts allow you to practically automate any process inside Corteza, and by using the API Corteza can interact with the outside world.
You can contribute to the documentation!
The documentation is managed in the Corteza github repository, enabling the community to contribute. Documentation is written in AsciiDoc format and processed with the open-source software AsciiDoctor.
These are the steps on how to contribute:
- Clone https://github.com/cortezaproject/corteza-docs.git
- Modify or add content
- You can check out the syntax and formatting rules of the AsciiDoc format, as well as recommended practices. Correct formatting makes it easier for other to review or expand the documentation.
- Create a pull request
More detailed info on how to contribute can be found in the readme file.
If you are not familiar with Github, check out this manual.
Where can I find the documentation?
The documentation has been published under https://docs.cortezaproject.org, and is licensed under Apache-2.0.
Leave a ReplyWant to join the discussion?
Feel free to contribute!