There are a few settings that will help you connect to your Acrolinx Platform.
First, enter the URL that the Git hosting provider can use to connect to your platform. Use the setting
:acrolinx-url as follows:
For example, if you're running the integration on the same computer as your Acrolinx Platform, enter the following value:
Example on Localhost
You only need to configure the Guidance Profile that you want to check with. Configure all check settings in the Checking Profile settings on the Acrolinx Platform.
The UUID of the Guidance Profile appears in the Acrolinx Dashboard. This setting supports ENV, system property, global remote configuration, and repository-specific configuration. To get a list of available Guidance Profiles and their UUIDs, you can also call this program with the command-line option
--acrolinx-capabilities. If you prefer, use the display name of the Guidance Profile instead of the UUID.
When in doubt, use the UUID—it doesn't change when you rename a Guidance Profile.
Want to capture information on who initiated the check? Configure a custom field where this can be stored:
:acrolinx-author-field "Key of the metadata field"
Again, you can get the available keys by calling up this program with the
--acrolinx-capabilities command-line option.
If you need your Scorecard in a language other than English, use the configuration setting
:acrolinx-client-locale to set it to a language that the Acrolinx Platform supports. For German, for example, set "de".
With the help of the
:metadata Git Hosting configuration, you can use Target Batch Mapping in your Markdown files. The configuration lets you map metadata in a Markdown file to document custom fields in Acrolinx. After you set up mapping, Acrolinx will automatically assign a Target to your Markdown file when you run a check. Read on to learn how to use it.
Sound like something you'd like to try out? Get in touch with your Acrolinx technical account manager to get the latest version of the log entries related to this private beta.
Make sure your Markdown files have a YAML front matter that defines file-specific metadata.
The YAML header that you use to annotate your Markdown files with metadata needs to be compliant with the YAML 1.2 specification. Otherwise, the integration won’t be able to parse the content within the header. This will result in an empty list of metadata.
If you want to use a `List`custom field, the values that you assign to the metadata should belong to the list of values set for the corresponding custom field. Otherwise, the Acrolinx for Git Hosting will ignore that particular metadata point. With `Text` custom fields, you can provide any textual information to the metadata values.
To set up Target Batch Mapping for Markdown files, do the following:
Create your document custom fields under Analytics > Administration > Custom Fields. Learn more about custom fields.
When you make a document custom field mandatory, make sure to add it as metadata in all Markdown documents that you want to check.
Link the document custom fields with the desired Target. Learn how in our article on Targets Batch Mapping.
Specify the mapping between the metadata in the Markdown file and your document custom fields via the
This feature flag will only be active if you do the following:
Turn off the
:guidance-profileconfiguration option at all configuration levels.
Make sure the document is a Markdown file ends with an “.md” extension.
Your users might interact with your platform via a different URL than the one you set for
:acrolinx-url. For example, if you set
localhost like in the example above, other users won't be able to access the links that are created with that URL. This means they won't be able to access links to Scorecards.
Users may need a different URL than the one set for
:acrolinx-url in the following scenarios:
You run Acrolinx for Git hosting providers on the same computer as your Acrolinx Platform.
You run Acrolinx for Git hosting providers behind the same TLS proxy setup as your Acrolinx Platform.
If other users can access the URL that you set for
:acrolinx-url, you don't need to do anything.
If your users need a different URL, use the setting
:acrolinx-public-url to set the public platform URL:
For example, if you're running your platform behind a reverse proxy, you'd enter your proxy server address. This would be something like the following value:
Example with Proxy