Skip to content

Commit 7031e49

Browse files
Jenny-JianiJenny-Jiani
committed
Merge branch 'main' into Jenny
2 parents dbdbfd7 + 9417b04 commit 7031e49

File tree

149 files changed

+9261
-311
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+9261
-311
lines changed

‎.github/workflows/full-site-build.yml‎

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ name: Full-Site-Build
55
# Controls when the workflow will run
66
on:
77
# Triggers the workflow on push events but only for the master branch
8-
push:
9-
branches: [ preview ]
8+
# push:
9+
# branches: [ preview ]
1010

1111
# Allows you to run this workflow manually from the Actions tab
1212
workflow_dispatch:
@@ -30,14 +30,24 @@ jobs:
3030
cd /home/ubuntu
3131
[ -d DDNDoc ] && rm -rf DDNDoc
3232
[ ! -d DDNDoc ] && mkdir -p DDNDoc
33-
[ -d document-normalizer-docs ] && rm -rf document-normalizer-docs
34-
mkdir -p document-normalizer-docs
35-
git clone --depth 1 --branch main https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs
36-
cp -rfp ./document-normalizer-docs/* ./DDNDoc/
37-
cd Docs-Template-Repo && git pull && cd .. && cp -rfp ./Docs-Template-Repo/* ./DDNDoc/
33+
[ ! -d document-normalizer-docs ] && git clone --depth 1 https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs
34+
[ ! -d Docs-Template-Repo-Preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
35+
cd document-normalizer-docs && git pull && cd .. && cp -rfp ./document-normalizer-docs/* ./DDNDoc/
36+
cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDoc/
3837
cd DDNDoc && bundle exec jekyll build
39-
python3 /home/ubuntu/ftp.py /home/ubuntu/DDNDoc/_site/ ./www.dynamsoft.com/document-normalizer/docs/ prod
40-
38+
#python3 /home/ubuntu/ftp.py /home/ubuntu/DDNDoc/_site/ ./www.dynamsoft.com/document-normalizer/docs/ prod
39+
40+
- name: Sync files
41+
uses: SamKirkland/[email protected]
42+
with:
43+
server: ${{ secrets.FTP_DYNAMSOFT_LOCAL_SERVER }}
44+
username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
45+
password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
46+
port: 21
47+
local-dir: /home/ubuntu/DDNDoc/_site/
48+
server-dir: /www.dynamsoft.com/document-normalizer/docs/
49+
50+
4151
Build-Preview:
4252
if: ${{ github.ref == 'refs/heads/preview' }}
4353
# The type of runner that the job will run on
@@ -55,15 +65,14 @@ jobs:
5565
cd /home/ubuntu
5666
[ -d DDNDocPreview ] && rm -rf DDNDocPreview
5767
[ -d document-normalizer-docs-preview ] && rm -rf document-normalizer-docs-preview
58-
mkdir -p DDNDocPreview
59-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs-preview
60-
cp -rfp ./document-normalizer-docs-preview/* ./DDNDocPreview/
61-
cd Docs-Template-Repo && git pull && cd .. && cp -rfp ./Docs-Template-Repo/* ./DDNDocPreview/
68+
[ ! -d DDNDocPreview ] && mkdir -p DDNDocPreview
69+
[ ! -d document-normalizer-docs-preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs-preview
70+
cd document-normalizer-docs-preview && git pull && cd .. && cp -rfp ./document-normalizer-docs-preview/* ./DDNDocPreview/
71+
cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDocPreview/
6272
sed -i -e "1,3s/blob\/master$/blob\/preview/" \
6373
-e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DDNDocPreview/_config.yml
64-
cd DDNDocPreview && bundle exec jekyll build #--incremental
74+
cd DDNDocPreview && bundle exec jekyll build
6575
66-
6776
- name: Sync files
6877
uses: SamKirkland/[email protected]
6978
with:

‎.github/workflows/main.yml‎

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,22 @@ jobs:
3030
- name: Run a multi-line script
3131
run: |
3232
cd /home/ubuntu
33+
[ -d DDNDoc ] && rm -rf DDNDoc
3334
[ ! -d DDNDoc ] && mkdir -p DDNDoc
34-
[ ! -d document-normalizer-docs ] && git clone --depth 1 --branch main https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs
3535
cd document-normalizer-docs && git pull && cd .. && cp -rfp ./document-normalizer-docs/* ./DDNDoc/
36-
cd Docs-Template-Repo && git pull && cd .. && cp -rfp ./Docs-Template-Repo/* ./DDNDoc/
36+
cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDoc/
3737
cd DDNDoc && bundle exec jekyll build
38-
python3 /home/ubuntu/ftp.py /home/ubuntu/DDNDoc/_site/ ./www.dynamsoft.com/document-normalizer/docs/ prod
38+
#python3 /home/ubuntu/ftp.py /home/ubuntu/DDNDoc/_site/ ./www.dynamsoft.com/document-normalizer/docs/ prod
39+
40+
- name: Sync files
41+
uses: SamKirkland/[email protected]
42+
with:
43+
server: ${{ secrets.FTP_DYNAMSOFT_LOCAL_SERVER }}
44+
username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
45+
password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
46+
port: 21
47+
local-dir: /home/ubuntu/DDNDoc/_site/
48+
server-dir: /www.dynamsoft.com/document-normalizer/docs/
3949

4050
Build-Preview:
4151
if: ${{ github.ref == 'refs/heads/preview' }}
@@ -45,16 +55,25 @@ jobs:
4555
# Steps represent a sequence of tasks that will be executed as part of the job
4656
steps:
4757
# Runs a set of commands using the runners shell
58+
- name: clear space
59+
run: |
60+
cd /home/ubuntu
61+
[ -d DDNDocPreview ] && rm -rf DDNDocPreview
62+
[ -d document-normalizer-docs-preview ] && rm -rf document-normalizer-docs-preview
63+
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
64+
cd /home/ubuntu
65+
4866
- name: Build the site
4967
run: |
5068
cd /home/ubuntu
5169
[ ! -d DDNDocPreview ] && mkdir -p DDNDocPreview
52-
[ ! -d document-normalizer-docs-preview ] && git clone --depth 1 --branch preview https://github.com/Dynamsoft/document-normalizer-docs.git document-normalizer-docs-preview
70+
[ ! -d document-normalizer-docs-preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs-preview
71+
[ ! -d Docs-Template-Repo-Preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
5372
cd document-normalizer-docs-preview && git pull && cd .. && cp -rfp ./document-normalizer-docs-preview/* ./DDNDocPreview/
54-
cd Docs-Template-Repo && git pull && cd .. && cp -rfp ./Docs-Template-Repo/* ./DDNDocPreview/
73+
cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDocPreview/
5574
sed -i -e "1,3s/blob\/master$/blob\/preview/" \
5675
-e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DDNDocPreview/_config.yml
57-
cd DDNDocPreview && bundle exec jekyll build --incremental
76+
cd DDNDocPreview && bundle exec jekyll build
5877
5978
- name: Sync files
6079
uses: SamKirkland/[email protected]

‎_config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ android_api: /document-normalizer/docs/programming/android/api-reference/
2727
android_release_notes: /document-normalizer/docs/programming/android/release-notes/
2828
android_camera_enhancer: /document-normalizer/docs/programming/android/api-reference/camera-enhancer/
2929

30+
javascript: /document-normalizer/docs/programming/javascript/
31+
javascript_api: /document-normalizer/docs/programming/javascript/api-reference/
32+
javascript_release_notes: /document-normalizer/docs/programming/javascript/release-notes/
33+
34+
xamarin: /document-normalizer/docs/programming/xamarin/
35+
xamarin_api: /document-normalizer/docs/programming/xamarin/api-reference/
36+
xamarin_release_notes: /document-normalizer/docs/programming/xamarin/release-notes/
37+
xamarin_camera_enhancer: /document-normalizer/docs/programming/xamarin/api-reference/camera-enhancer/
38+
3039
enumerations: /document-normalizer/docs/programming/enumerations/
3140
parameters_reference: /document-normalizer/docs/parameters/reference/
3241
release_notes: /document-normalizer/docs/release-notes/

‎_data/full_tree.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ tree_file_list:
33
- sidelist-introduction.html
44
- sidelist-parameters.html
55
- sidelist-programming.html
6+
- sidelist-useful.html
67
- sidelist-release-notes.html
78
- sidelist-license.html
89
- sidelist-programming/programming-android.html
910
- sidelist-programming/programming-ios.html
1011
- sidelist-programming/programming-c.html
1112
- sidelist-programming/programming-cpp.html
13+
- sidelist-programming/programming-xamarin.html
14+
- sidelist-programming/programming-javascript.html
1215
- sidelist-parameters/parameters-reference.html

‎_data/product_version.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
version_info_list:
2-
- latest version
2+
- latest version
3+
- 1.0.0
4+
5+

‎_includes/sidelist-full-tree.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%}
22
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming.html" -%}
33
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters.html" -%}
4-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%}
5-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-license.html" -%}
4+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-useful.html" -%}
5+
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%}
6+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-license.html" -%} -->

‎_includes/sidelist-parameters.html‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
<li><a href="{{ site.parameters }}" class="otherLinkColour">Parameters</a>
2-
<ul>
3-
<li><a href="{{ site.parameters }}parameter-organization-structure.html" class="otherLinkColour">Parameter Organization Structure</a></li>
4-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters/parameters-reference.html" -%}
5-
</ul>
6-
</li>
1+
<li class="category">UNDERSTANDING DDN</li>
2+
<li><a href="{{ site.parameters }}parameter-organization-structure.html" class="otherLinkColour">Parameter Organization Structure</a></li>
3+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters/parameters-reference.html" -%}

‎_includes/sidelist-programming.html‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
<li><a href="{{ site.programming }}" class="otherLinkColour">Programming</a>
1+
<!-- <li><a href="{{ site.programming }}" class="otherLinkColour">Programming</a>
22
<ul>
33
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%}
44
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
55
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-c.html" -%}
66
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-cpp.html" -%}
77
</ul>
8-
</li>
8+
</li> -->
9+
<li class="category">DEVELOPMENT</li>
10+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%}
11+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
12+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-c.html" -%}
13+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-cpp.html" -%}
14+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-xamarin.html" -%}
15+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-javascript.html" -%}

‎_includes/sidelist-programming/programming-c.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
<li><a href="{{ site.enumerations }}image-pixel-format.html?src=c" class="otherLinkColour">ImagePixelFormat</a></li>
2828
</ul>
2929
</li>
30+
<li><a href="{{ site.enumerations }}error-code.html?src=c" class="otherLinkColour">Error Codes</a></li>
3031
</ul>
3132
</li>
3233
<li><a href="{{ site.c_release_notes }}" class="otherLinkColour">Release Notes</a>

‎_includes/sidelist-programming/programming-cpp.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
<li><a href="{{ site.enumerations }}image-pixel-format.html?src=cpp" class="otherLinkColour">ImagePixelFormat</a></li>
2929
</ul>
3030
</li>
31+
<li><a href="{{ site.enumerations }}error-code.html?src=cpp" class="otherLinkColour">Error Codes</a></li>
3132
</ul>
3233
</li>
3334
<li><a href="{{ site.cpp_release_notes }}" class="otherLinkColour">Release Notes</a>

0 commit comments

Comments
 (0)