Skip to content

Locating a file for IvorySQL documentation

Jump to bottom
Muhammad Usama edited this page Dec 24, 2021 · 1 revision

Ivorysql-www repository contains the documentation for IvorySQL. Currently the documentation is localized for English and Chinese language.

If you find a mistake in some document or want to contribute a new document you can refer to the below directory structure for locating the correct file location to make a required change.

Directory structure

Ivory-www 	                    <= [Root Dir]
│
└── docs                            <= [English Docs] [Devel Version][IvorySQL Master]
│  │
│  ├── intro.md
│  ├── compatibility_Features
│      └── package.md               <= [English][Devel Version]
│      │                               [PACKAGE Documentation]
│      └──   ...
│
└── versioned_docs                  <= [English Docs][Released Versions]
│  │
│  ├── version-1.0                  <= [English Docs][IvorySQL 1.0]
│      └── intro.md
│      ├── compatibility_Features
│          └── package.md           <= [English][IvorySQL 1.0]
│          │                           [PACKAGE Documentation]
│          └──   ...
│
└── i18n	                    <= [Other Languages Dir]
   │
   ├── zh-CN                        <= [Chinese Languages Dir]
       │
       ├── docusaurus-plugin-content-docs
           │
           ├── current             <= [Chinese Docs][Devel Version]
           │                          [IvorySQL Master]
           │   └── intro.md
           │   ├── compatibility_Features
           │       └── package.md  <= [Chinese][Devel Version]
           │       │                  [PACKAGE documentation]
           │       └──   ...
           │       
           ├── version-1.0         <= [Chinese Docs][IvorySQL 1.0]
               └── intro.md
               ├── compatibility_Features
                   └── package.md  <= [Chinese][IvorySQL 1.0]
                   │                  [PACKAGE Documentation]
                   └──   ...

Making a change

Suppose you want to make a change to PACKAGE documentation for all versions and for both English and Chinese language.
You will have to change the package.md file at following locations.

1- English language Devel Version

docs/Compatibillity_Features/package.md

2- English language IvorySQL 1.0 Version

versioned_docs/version-1.0/Compatibillity_Features/package.md

3- Chinese language Devel Version

i18n/zh-CN/docusaurus-plugin-content-docs/current/Compatibillity_Features/package.md

4- Chinese language IvorySQL 1.0 Version

i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0/Compatibillity_Features/package.md

Sample patch

Add a new SQL tag to PACKAGE documentation for all versions and for both English and Chinese language.

diff --git a/docs/Compatibillity_Features/package.md b/docs/Compatibillity_Features/package.md
index 629db67..f79e70f 100644
--- a/docs/Compatibillity_Features/package.md
+++ b/docs/Compatibillity_Features/package.md
@@ -4,6 +4,7 @@ sidebar_label: 'Packages'
 title: Packages
 tags:
   - Oracle Style Packages
+  - SQL
 ---

 ## Package Overview
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/Compatibillity_Features/package.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/Compatibillity_Features/  package.md
index 3e406f2..d9b595a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/Compatibillity_Features/package.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/Compatibillity_Features/package.md
@@ -5,6 +5,7 @@ title: 包
 tags:
   - Oracle Style Packages
   - 包
+  - SQL
 --- 
 
 ## 软件包概述
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0/Compatibillity_Features/package.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0/                  Compatibillity_Features/package.md
index 3e406f2..d9b595a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0/Compatibillity_Features/package.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.0/Compatibillity_Features/package.md
@@ -5,6 +5,7 @@ title: 包
 tags:
   - Oracle Style Packages
   - 包
+  - SQL
 ---

 ## 软件包概述
diff --git a/versioned_docs/version-1.0/Compatibillity_Features/package.md b/versioned_docs/version-1.0/Compatibillity_Features/package.md
index 629db67..f79e70f 100644
--- a/versioned_docs/version-1.0/Compatibillity_Features/package.md
+++ b/versioned_docs/version-1.0/Compatibillity_Features/package.md
@@ -4,6 +4,7 @@ sidebar_label: 'Packages'
 title: Packages
 tags:
   - Oracle Style Packages
+  - SQL
 ---

 ## Package Overview
Clone this wiki locally