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 ( > ).
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.
The knowledge base provides five catagories:
- Connect With Exasol
- Data Science
- Database Features
- Environment Management
- Support and Services
- Access the GitHub repository at exasol\Public-Knowledgebase.
- In GitHub, click Fork and create a new branch.
- Select the apporpriate template in the Templates folder and copy the content.
- Using your tool's commands, create a new file and copy the template's content into that file.
- Save the file in the appropirate category folder.
- Write the article using styles listed in the Exasol Styles section of this readme and instructions in the template.
- 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.
- Once you are happy with the article, use your tool to commit and push the changes.
- In GitHub, click Pull request, New pull request, and then click Create pull request.
Please keep in mind the following limitations when creating or modifying KB articles:
- Images must not be larger than 1 MB.
- Do not include the < or > symbol in your Markdown. If you need to use the symbols, use "<" or "%gt;" instead to represent those characters
- Use <br /> instead of <br>
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.
-
Text formatting-summary: Provides Google formatting notes for markdown documents.
-
Microsoft Writing Style Guide: Use when the Google Style Guide doesn't answer your question.
Do not spell out on first use.
Use "can not" as two words.
Parameter – A description on how to run a command.
Value – The value of a parameter.
Do not use.
The process of moving to a full version of Exasol or to a new full version of Exasol. For example, migrating to Exasol for the first time or migrating from Exasol 7.1 to Exasol 8.0.
Use "multi-node" with a hyphen when referring to some type of system or process that involves more than one node. Otherwise, use the plural form of node (i.e., nodes). Remember, some "multi" prefix words do not have a hyphen per the Google Style Guide. For example, multicloud vs. multi-cluster.
Use "On-prem" in either of the following situations:
- The platform selected in Exasol Help.
- The choice a customer makes to run Exasol at a location the customer owns or rents with their own hardware.
When referring to hardware being located at a facility the customer owns or rents, per the Google Style Guide, use "on-premises".
Example: If you run Exasol in your own on-premises environment using your own hardware, choose On-prem.
Only use to reference the ROLLBACK statement.
Noun; do not use.
Use roll back as a two-word verb to describe the process of rolling back a database after a COMMIT using the ROLLBACK statement.
Use as a verb to describe the process of reverting to a former version of Exasol.
- Web console - Say "in the web console" not "in the SaaS web console" or "on the X (e.g., Worksheets) web page." Two lower case words with no hyphen.
- Exasol SaaS - Use when no specific edition is mentioned.
- Exasol SaaS account - Use instead of SaaS environment.
- Exasol SaaS Enterprise edition - Use on first reference.
- Exasol SaaS Standard edition - Use first reference.
- Enterprise edition - Subsequent uses.
- Standard edition - Subsequent uses.
- edition - Either Enterprise or Standard. For example, "select a different edition."
To reference the team Support, write Support with an uppercase "S". To reference a support request, write support with a lowercase "s".
To instruct the user to contact Support, use one of the following.
- For non-SaaS products: If you need assistance, create a case.
- For SaaS UI: "To send a support request, click Help and then click Support.
Do not use with Exasol Database products. Use update or migration.
Use with SaaS when changing subscriptions. For example: "When you upgrade from Standard edition to Enterprise edition…"
The process of installing intermediate releases such as bug fixes. For example, Exasol 7.0 to Exasol 7.1 or Exasol 7.1 to Exasol 7.1.1. products.