Testing product - API documentation

Documentation pipeline 4.1

Testing link replacement for documentation v2 sync job

Link in linkMap Link to te portal - fine

Link not in map Link not in map Link not in map

NEW TEST updates for build test trigger

Corporate Access Authorization API

|Corporate Access Authorization API

API Version 2

Mass Payments API|API Version 1

Mass Payments API API Version 1

test 3

test text to replace

test 2 & zupa

test 3 &zupa

The pipeline is taking markdown documents from release notes and copy pasting it into cloud gitlab

Testing if this will compile in md https://wrong.link.com

IMPORTANT Script used for parsing confluence is removing all links which are nested in headers so DO NOT put links in headings!

IMPORTANT For accessibility and good practices - Heading level should only be increased by one

Testing Confluence to API Market pipeline

To test the flow you can:

  1. Go to test confluence page - test markdown confluence page
  2. Modify the page / check the source code
  3. Run the pipeline with 2024test parameter
  4. Check the result on API Market in development environment

Headings - BAD EXAMPLE

This is header h2

This is header h4 - should be h3 instead - not visible in the left navigation in API Market frontend

Headings - GOOD EXAMPLE

This is header h2

This is header h3

h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading
h6 Heading

Horizontal Rules


Typographic replacements

Enable typographer option to see result.

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

test.. test… test… test?… test!…

!!!!!! ???? ,, — ---

“Smartypants, double quotes” and ‘single quotes’

Emphasis

This is bold text

This is bold text

This is italic text

This is italic text

Strikethrough

Blockquotes

Blockquotes can also be nested…

…by using additional greater-than signs right next to each other…

…or with spaces between arrows.

Lists

Unordered

  • Element 1 - Create a list by starting a line with *
  • Element 2:
    • Element 2.1:
    • Element 2.2:
      • Element 2.2.1:
  • Very easy!

Ordered

  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Integer molestie lorem at massa
  4. You can use sequential numbers…
  5. …or keep all the numbers as 1.

Ordered List

  1. First item
  2. Second item
    1. Subitem 2.1
    2. Subitem 2.2
  3. Third item

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code

Syntax highlighting

var foo = function (bar) {
  return bar++;
};

console.log(foo(5));

Tables

OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.

link text

link with title

Autoconverted link https://github.com/nodeca/pica (enable linkify to see)

Link to heading #documentation-pipeline

Link to heading #lists

For anchor links to heading which are not a single world you need to replace whitespace with dash _ (normally it is - for markdown but our frontend works now only with _)

Images

Adding new images

Check how to add new images

Minion