> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update the Documentation

# Update the Documentation

One important part of developing a new connector is to document how it works after it is done.

The documentation for connectors can be found within `openmetadata-docs/content/v{version}-SNAPSHOT/connectors`
where `{version}` depends on the time of reading.

There you need to create a new folder within the proper Source Type you are building a connector for (Database, Dashboard, MLModel, etc) and create two files:

* **index.mdx**: It explains how to configure the connector using the UI.
* **yaml.mdx**: It explains how to configure the connector using a YAML file.

Again the best way to create the documentation is to use another connector's documentation as a base since they all follow the same structure.

Once the documentation is done, it's important to add it to the proper indexes and menus:

* `openmetadata-docs/content/v{version}-SNAPSHOT/menu.mdx`
* `openmetadata-docs/content/v{version}-SNAPSHOT/connectors/index.mdx`
* `openmetadata-docs/content/v{version}-SNAPSHOT/connectors/{source_type}/index.mdx`

This will guarantee that the connector is shown in the menus.

## Guidelines for Adding Connector Documentation

When adding documentation for a new connector, ensure the following steps are completed:

### 1. Update the Connectors List

* Add the connector entry to the relevant version file located at:
  `partials/v1.x.x/...connectors-list.mdx`
  This ensures the connector is displayed in the list for the appropriate version.

### 2. Add Connector Logo

* Upload the connector's logo to the directory:
  `/public/images/connectors`

### 3. Update Menu

* Update the following files to reflect the addition of the new connector:
  * `menu.mdx`

### 4. Update Homepage Connectors List

* Add the new connector to the homepage connectors list.
  **Note:** Ping the responsible person to ensure this step is completed.

### 5. Include Installation Images

* Add images for the installation steps of the connector.
  Images should be added for **all versions** in the following directory:
  `/public/images/[version]/connectors/[connectorName]`
* Ensure the images align with the steps described in the installation documentation for the connector.

By following these guidelines, the connector documentation will be consistent and meet the required standards.

## How to test the Documentation

You can check your changes in the documentation by building it locally using `make docker-docs`. This will pull the OpenMetadata documentation Docker images and mount the project as a volume.

You should be able to see the documentation page on `http://localhost:3000`.

<Tip>
  **Attention**

  Beware that any version that is suffixed with `-SNAPSHOT` is not shown. So in order to check it out you will need to remove the suffic and add it again afterwards.
</Tip>