swenelges / public-knowledgebase

Exasol Knowledge Base

Welcome

Welcome to the Exasol Knowledge Base (KB)! This repository contains files and information needed to create a KB article.

Exasol KB articles must be created using Markdown (.md) format. If you are new to Markdown, see Markdown Guide's Getting Started section. There are also many programs that will convert, say, Microsoft Word (.docx) files to Markdown files.

Your final article will be converted to HTML and rendered on the Exasol Knowledge Base website. Please use only basic Markdown syntax.

Note: Using other flavors of Markdown may not work as expected when rendered on Exasol's website. Even some basic syntax does not work as expected. For example, do not use Blockquotes ( > ).

Templates

You can choose one of the following templates:

• Question and Answer: Pose a quick question with a specific answer.
• Solution to a Problem: Provide workarounds for bugs or new shortcuts that you would like to share with others.
• Tutorial: A quick tutorial for a specific task.
• EXplanation: More information about a task or concept.

Catagories

The knowledge base provides five catagories:

• Connect With Exasol
• Data Science
• Database Features
• Environment Management
• Support and Services

Create a KB Article

1. Access the GitHub repository at exasol\Public-Knowledgebase.
2. In GitHub, click Fork and create a new branch.
3. Select the apporpriate template in the Templates folder and copy the content.
4. Using your tool's commands, create a new file and copy the template's content into that file.
5. Save the file in the appropirate category folder.
6. Write the article using styles listed in the Exasol Styles section of this readme and instructions in the template.
7. Each category folder contains a subfolder called images. If you have images, place them in your chosen category's images folder. Make sure the size of each image does not exceed 1 MB.
8. Once you are happy with the article, use your tool to commit and push the changes.
9. In GitHub, click Pull request, New pull request, and then click Create pull request.

Limitations

Please keep in mind the following limitations when creating or modifying KB articles:

1. Images must not be larger than 1 MB.
2. Do not include the < or > symbol in your Markdown. If you need to use the symbols, use "&lt;" or "%gt;" instead to represent those characters
3. Use <br /> instead of <br>

Exasol Styles

Exasol's official style guide is the Google Style Guide. Reference all questions there first. If the Google Style Guide does not answer your question, as the Google Style Guide recommends, go to the Microsoft Writing Style Guide.

Some Exasol styles do differ from Google and Microsoft, and Exasol is in the process of changing styles to more align with Google. Please scan the following style guide for information on Exasol specific styles.

Links

• Text formatting-summary: Provides Google formatting notes for markdown documents.

• Google Style Guide

• Google Word List

• Microsoft Writing Style Guide: Use when the Google Style Guide doesn't answer your question.