This is the repository for MuleSoft’s documentation and contains the source content for the docs site.
MuleSoft welcomes contributions from the community! You can contribute or provide feedback for our documentation in the following ways:
-
Fork this repository, make edits, and submit a pull request. We respond to your request as quickly as possible.
-
File an issue. Be as specific as possible about the changes you’d like to see.
-
While viewing a page on our docs site, you can rate a specific topic and include comments for fixes, suggestions, or general feedback.
-
Send mail to the docs team: documentation@mulesoft.com
-
See the MuleSoft Docs Style Guide for writing tips.
Before you can contribute to our documentation, you need to complete two steps to acknowledge that you’ve read and accepted our Contributor’s Agreement:
-
Review the agreement, which is available here.
-
After you’ve read and agree to the agreement, you need to fill out the MuleSoft Contributor’s Agreement form and submit it to us. This form exists as an API notebook and does two things:
-
Identifies you using your GitHub account, and
-
Records your name as a contributor
-
After you’ve submitted the form, you are asked to authenticate to GitHub and accept our Contributor’s Agreement. When the script completes, an Issue is created in our contributor’s project with your name.
That’s it! You’re now able to make contributions to our documentation. Ready to get started?
After you accept our Contributor’s Agreement, you can simply fork our documentation repository and make changes, then submit a pull request.
Alternatively, you can click the Edit on GitHub link at the top of a page, click the pencil icon, and make your change.
The pull request is reviewed by our team as soon as possible.
The following sections describe the MuleSoft Docs publishing style.
| Style | Correct Example | Incorrect Example |
|---|---|---|
Use active text instead of "will", "you’ll", "won’t", or "we’ll". |
This feature initializes and merges your code. |
This feature will initialize and merge your code. |
Obfuscate login credentials in illustrations and code |
The client secret is 4242424242424242-ABADDOG |
My password is foobar123 |
Only use RFC-1918 IP addresses for example IPv4 addresses: |
Set the server address to 10.1.1.42 |
For example, set the address to 42.42.42.42. |
Use the example.com domain |
For example, mydomain@example.com |
|
Omit "please" |
Contact MuleSoft Customer Support. |
Please contact MuleSoft Customer Support. |
Separate options with > and don’t cast the > in bold |
File > New > Mule Project |
File → New → Mule Project |
Replace "in order to" with "to" |
To start the procedure, |
In order to start the procedure |
Omit "then" |
Click this and that |
Click this, and then click that |
Don’t use "select" if you mean click. Select only highlights text. Click activates a link or button. |
Click OK. |
Select OK. |
Omit button ellipses |
Click Test Connections. |
Click Test Connections…. |
Omit "on" with click |
Click Test Connections. |
Click on Test Connections. |
Init-cap words in headings |
Default Value Setting |
Default value setting |
Spell out i.e. and e.g. |
Create a connector, for example, for Salesforce |
Create a connector, e.g. for Salesforce |
Don’t put code examples in a screenshot |
Put code in a source block |
screenshot |
Put a period outside a quote string |
Don’t say "will". |
Don’t say "will." |
Use the Oxford comma |
a, b, and c |
a, b and c |
Omit the trademark symbol |
Anypoint Platform |
Anypoint™ Platform™ |
-
[source]is better than[source,code]. -
Better to use "a" columns in tables such as cols="30a,70a".
-
Omit
linenumsoption on 1 line code examples. -
Put multi-word examples in a source block instead of a long tick marked string.
-
Tab names should be "Visual Studio Editor" and "XML Editor or Standalone".
-
Only XML or XML procedures can be in an XML tab. It’s illogical to put a screenshot in the XML tab.
-
Restrict tables to 2 or 3 columns - multi-column tables can be very difficult to read.
-
Wrap code example lines at spaces, or for Java after a dot. Code lines should be less than 60 characters, especially if you use the \//<n> notation for callouts
-
Until Coderay fixes the spacing for line numbers, don’t reference code examples by line numbers. Instead usee \//<1> in the code example and reference the notation in the text below the code example.
| Rule | Description | Example |
|---|---|---|
Imperative before lists |
Before starting a list, provide a starting sentence that starts with "to" that describes the task you want people to provide. Also, don’t start a bullet or numbered list after a heading without a starting sentence. |
To set the values: |
Insert a period at the end of a sentence or bullet list item |
Perform these tasks. |
Perform these tasks |
Start each item in a bullet list or numbered list with a capital letter |
Start list items that are not reserved words with an init cap |
|
Start number list items with an action |
Number list items only start with an action such as Click, Set, etc. |
|
| Font | Description | Example |
|---|---|---|
Bold |
A button or field name |
Click Test Connections. |
|
Reserved words or code examples, such as a MEL expression |
|
Italics |
Emphasis |
Ensure the checkbox is set |
Bold italics |
Mule Enterprise license requirements. |
Enterprise |
Bold links |
Important links like Skip to Code |
*\<\<Skip to Code>>* |
-
No special characters in headings
-
Init-cap each word in a heading
-
Don’t put a colon at the end of a heading
-
Ensure headings are in order, h1 > h2 > h3 > h4. Don’t skip levels such as h2 > h5
-
Only one H1 per doc at the top of the file
-
Don’t number headings