Wiki Format Guidelines

Guidelines for writing documentation

This guide's intention is to help with your task of adding documentation to the sap-customer-data-cloud-accelerator git repository.

In every team, we have several hands contributing to our project documentation and it's usual that some will use this to represent a button and others will use this, but at the end of the day, we want our readers to look at a coherent and comprehensive documentation that is easy to go through.

That's why this guide will help everyone follow standard formatting.

Titles

# Use this for h1

## Use this for h2

### Use this for h3

etc...

Click here to know more

Buttons

To mention a name of a button or folder, use this format: "click on Save button"

Wrap the button name like `this`

Click here to know more

Files

To mention a name of a file use this format: E.g: "Unzip the sap-customer-data-cloud-toolkit-.zip file"

Wrap the name of the file around 2 pairs of **

Click here to know more

Link

To add a link to a piece of text: [add text here](add the link here)

Click here to know more

List

To create a list, each item has to be preceded by "-". Example:

• item 1
• item 2

Click here to know more

Images

Images used on the GitHub Wiki should be hosted in the corresponding repository and added to the documentation like this:


Commands

To describe commands that can be used by the readers, add 4 blank spaces before your command to create a copiable area.

npm run init 

Quoting Text

Using > before the text will create different text formatting.

This highlights information that users should take into account.

Click here to know more

Quoting Code

To add a code snipped, wrap it like this:

```

Add your code here

```

Click here to know more

Collapsed Text

To use collapsed text use the following structure:

<details>

<summary>Title

</summary>

information inside

can be as long as needed

\</details>

Result:

src/inject/injectMenu.js

Functions necessary to inject the menu buttons into the SAP Customer Data Cloud Console DOM, as well show them and hide them when depending on the state of the app.

Notes[^1]

[^1]: If you notice there is any element you use that is missing from this guide, please add it here.