Guidelines for contributing to documentation
This document gives a quick introduction in how to contribute to the ATS documentation.
Mendix guidelines
Contribute to the Mendix Documentation
How-To Template
Reference Guide Page Template
GitBook help
Helpful tools
Hemingway Editor - Helps to write simple and clear.
Grammarly - Checks your grammar.
Important remarks
The links to other pages don't work, I had to add the missing .md to the file name
Never link by using the full file name. Always omit the .md extension. The links won't work in GitBook but on the Mendix website.
Naming of files and folders
Please stick with the current naming conventions.
FAQs
I can't find what I'm looking for in the TABLE OF CONTENTS tab, I have to look in the FILES tab
The TABLE OF CONTENTS tab is specific for GitBook. Any changes we do here are not reflected in the documentation when it is published. Please simply ignore this tab and work with the files directly.
How can I see if I have made changes to a document?
The blue Publish/Save button on the top right will be enabled if there are unsaved changes to the document.
How do I switch to raw mode to edit in Markdown?
Press the ? icon on the bottom right and enable Edit Markdown.
I've made changes to a document but don't want to save them. How can I revert the changes on the document?
There are two options:
- Use the undo function
- In the left sidepanel, right click on the file and select Discard Changes
I've made changes or created a new document and want it to be review before it's published. How do I do that?
Use the Create a change request function top left. This will create a Change request from the Primary version with all your current unpublished changes. This Change request can be reviewed by other users and merged into the Primary version.
You can continue editing your Change request after it has been created. To switch between the Primary version and Change requests use the link top left.
Also see What are Change Requests.
I'm working with the GitBook Editor desktop application. How do i see the latest changes from other users?
You can sync changes from other users by selecting the function Sync in the Book menu.
I have feedback on the documentation. How do I communicate this feedback?
You can use the built-in comment function from GitBooks. It is only available in Read mode.
- Open the documentation in Read mode here or by clicking the Read button.
- Hover a text paragraph until you see the + button on the right.
- Click the + button, enter your comment and submit. You've started a new discussion. All discussions are also listed on the start page in the Discussions tab.
