Skip to content

Commit 65db175

Browse files
muqarrab-asposemuqarrab-aspose
authored
Merge pull request #6 from groupdocs-cloud/staging
Merge
2 parents dd17e16 + 00cf0d4 commit 65db175

File tree

39 files changed

+7839
-1
lines changed

39 files changed

+7839
-1
lines changed

‎.github/workflows/comparison-production.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: tutorials.groupdocs.cloud(comparison)(family)(Production)
4+
5+
# Controls when the action will run.
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the master branch
8+
push:
9+
branches: [ master ]
10+
paths:
11+
- 'content/comparison/**'
12+
pull_request:
13+
branches: [ master ]
14+
paths:
15+
- 'content/comparison/**'
16+
17+
# Allows you to run this workflow manually from the Actions tab
18+
workflow_dispatch:
19+
20+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
21+
jobs:
22+
# This workflow contains a single job called "build"
23+
build:
24+
# The type of runner that the job will run on
25+
runs-on: ubuntu-latest
26+
27+
# Steps represent a sequence of comparison that will be executed as part of the job
28+
steps:
29+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
30+
- name: Checkout
31+
uses: actions/checkout@v2
32+
with:
33+
submodules: true # Fetch Hugo themes
34+
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
35+
- name: Checkout theme repo
36+
uses: actions/checkout@main
37+
with:
38+
repository: groupdocs-cloud/tutorials-theme
39+
token: ${{ secrets.REPO_TOKEN }}
40+
fetch-depth: 0
41+
path: themes/tutorials-theme
42+
# Step 2 - Sets up the latest version of Hugo
43+
- name: Setup Hugo
44+
uses: peaceiris/actions-hugo@v2
45+
with:
46+
hugo-version: '0.135.0'
47+
extended: true
48+
- name: Install Dependicies1
49+
run: npm install -D --save autoprefixer
50+
- name: Install Dependicies2
51+
run: npm install -D --save postcss-cli
52+
# Also specifies the theme we want to use
53+
- name: Build
54+
run: hugo --configDir config/comparison --environment production --minify
55+
56+
- name: Deploy tutorials.groupdocs.cloud(comparison)(family)(Production) to S3
57+
run: hugo --configDir config/comparison --environment production deploy --target "Production" --maxDeletes 0
58+
env:
59+
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
60+
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}
61+
# Invalidate Cloudfront
62+
- name: invalidate
63+
uses: chetan/invalidate-cloudfront-action@v2
64+
env:
65+
DISTRIBUTION: ${{ secrets.AWS_DISTRIBUTION_PROD }}
66+
PATHS: /comparison/*
67+
AWS_REGION: 'us-west-2'
68+
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
69+
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}

‎.github/workflows/comparison-staging.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: qa-tutorials.groupdocs.cloud(comparison)(family)(Stage)
4+
5+
# Controls when the action will run.
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the master branch
8+
push:
9+
branches: [ staging ]
10+
paths:
11+
- 'content/comparison/**'
12+
pull_request:
13+
branches: [ staging ]
14+
paths:
15+
- 'content/comparison/**'
16+
17+
# Allows you to run this workflow manually from the Actions tab
18+
workflow_dispatch:
19+
20+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
21+
jobs:
22+
# This workflow contains a single job called "build"
23+
build:
24+
# The type of runner that the job will run on
25+
runs-on: ubuntu-latest
26+
27+
# Steps represent a sequence of comparison that will be executed as part of the job
28+
steps:
29+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
30+
- name: Checkout
31+
uses: actions/checkout@v2
32+
with:
33+
submodules: true # Fetch Hugo themes
34+
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
35+
- name: Checkout theme repo
36+
uses: actions/checkout@main
37+
with:
38+
repository: groupdocs-cloud/tutorials-theme
39+
token: ${{ secrets.REPO_TOKEN }}
40+
fetch-depth: 0
41+
path: themes/tutorials-theme
42+
# Step 2 - Sets up the latest version of Hugo
43+
- name: Setup Hugo
44+
uses: peaceiris/actions-hugo@v2
45+
with:
46+
hugo-version: '0.135.0'
47+
extended: true
48+
- name: Install Dependicies1
49+
run: npm install -D --save autoprefixer
50+
- name: Install Dependicies2
51+
run: npm install -D --save postcss-cli
52+
# Also specifies the theme we want to use
53+
- name: Build
54+
run: hugo --configDir config/comparison --environment staging --minify
55+
56+
- name: Deploy qa-tutorials.groupdocs.cloud(comparison)(family)(Stage) to S3
57+
run: hugo --configDir config/comparison --environment staging deploy --target "Stage" --maxDeletes 0
58+
env:
59+
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
60+
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}
61+
# Invalidate Cloudfront
62+
- name: invalidate
63+
uses: chetan/invalidate-cloudfront-action@v2
64+
env:
65+
DISTRIBUTION: ${{ secrets.AWS_DISTRIBUTION }}
66+
PATHS: /comparison/*
67+
AWS_REGION: 'us-west-2'
68+
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
69+
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}

‎config/comparison/_default/config.toml‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
baseURL = "/comparison"
2+
title = "GroupDocs Cloud Tutorials"
3+
staticdir = 'content/static'
4+
enableRobotsTXT = true
5+
enableGitInfo = true
6+
disableKinds = ["taxonomy", "taxonomyTerm", "page", "RSS"]
7+
8+
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
9+
theme = ["tutorials-theme"]
10+
11+
[params.menu]
12+
zh = "groupdocscloud-zh"
13+
ru = "groupdocscloud-ru"
14+
ar = "groupdocscloud-ar"
15+
cs = "groupdocscloud-cs"
16+
de = "groupdocscloud-de"
17+
el = "groupdocscloud-el"
18+
es = "groupdocscloud-es"
19+
fr = "groupdocscloud-fr"
20+
hi = "groupdocscloud-hi"
21+
hu = "groupdocscloud-hu"
22+
id = "groupdocscloud-id"
23+
it = "groupdocscloud-it"
24+
ja = "groupdocscloud-ja"
25+
ko = "groupdocscloud-ko"
26+
nl = "groupdocscloud-nl"
27+
pl = "groupdocscloud-pl"
28+
pt = "groupdocscloud-pt"
29+
sv = "groupdocscloud-sv"
30+
th = "groupdocscloud-th"
31+
tr = "groupdocscloud-tr"
32+
vi = "groupdocscloud-vi"
33+
zh-hant = "groupdocscloud-zht"
34+
35+
defaultContentLang = 'en'
36+
[languages]
37+
[languages.en]
38+
contentDir = 'content/comparison/english'
39+
languageName = 'English'
40+
languageCode = "en"
41+
flag = "flag-us"
42+
weight = 10
43+
44+
ignoreFiles = ["(?i:readme.md)", '\.spin$']
45+
46+
# Image processing configuration.
47+
[imaging]
48+
resampleFilter = "CatmullRom"
49+
quality = 75
50+
anchor = "smart"
51+
52+
[services]
53+
[services.googleAnalytics]
54+
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
55+
# id = "UA-00000000-0"
56+
57+
[markup]
58+
[markup.tableOfContents]
59+
endLevel = 2
60+
ordered = true
61+
startLevel = 2
62+
[markup.goldmark]
63+
[markup.goldmark.renderer]
64+
unsafe = true
65+
[markup.highlight]
66+
anchorLineNos = false
67+
codeFences = true
68+
guessSyntax = false
69+
hl_Lines = ""
70+
lineAnchors = ""
71+
lineNoStart = 1
72+
lineNos = false
73+
lineNumbersInTable = true
74+
noClasses = false
75+
tabWidth = 4
76+
77+
# Everything below this are Site Params
78+
79+
[params]
80+
copyright = "The GroupDocs Cloud Authors"
81+
privacy_policy = "https://policies.google.com/privacy"
82+
topbar_search_active = false
83+
logo_rel_link = ""
84+
85+
# Containerize Menu
86+
[params.containerize]
87+
menu = "groupdocscloud-en"
88+
89+
[params.meta]
90+
msapplication_TileColor = "#2b5797"
91+
msapplication_config = "https://cms.admin.containerize.com/templates/groupdocscloud/images/browserconfig.xml"
92+
theme_color = "#ffffff"
93+
author = "GroupDocs Cloud"
94+
95+
# Title of 404 page
96+
title_404_page = "404 - Page Not Found | GroupDocs Cloud Tutorials"
97+
98+
# Open Grapgh settings
99+
title = "GroupDocs Cloud Tutorials"
100+
images = ["images/aspose-cloud-image-for-open-graph.jpg"]
101+
description = "REST APIs along with open-source SDKs that allow developers to enhance applications with the capability to display, annotate, convert, e-sign, merge, classify, compare & translate documents in the Cloud"
102+
103+
104+
# Set to true to disable breadcrumb navigation.
105+
breadcrumb_disable = false
106+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
107+
sidebar_search_disable = true
108+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
109+
navbar_logo = false
110+
# Set to true to disable the About link in the site footer
111+
footer_about_disable = false
112+
113+
114+
[minify]
115+
disableCSS = false
116+
disableHTML = false
117+
disableJS = false
118+
disableJSON = false
119+
disableSVG = false
120+
disableXML = false
121+
minifyOutput = true
122+
[minify.tdewolff]
123+
[minify.tdewolff.css]
124+
decimals = -1
125+
keepCSS2 = true
126+
[minify.tdewolff.html]
127+
keepConditionalComments = true
128+
keepDefaultAttrVals = true
129+
keepDocumentTags = true
130+
keepEndTags = true
131+
keepQuotes = false
132+
keepWhitespace = false
133+
[minify.tdewolff.js]
134+
[minify.tdewolff.json]
135+
[minify.tdewolff.svg]
136+
decimals = -1
137+
[minify.tdewolff.xml]
138+
keepWhitespace = false
139+
140+
[Taxonomies]
141+
142+
[deployment]
143+
[[deployment.matchers]]
144+
# Set custom content type for /sitemap.xml
145+
#pattern = "^sitemap\\.xml$"
146+
#pattern = "^[a-z]\\.xml$"
147+
pattern = "^.+\\.(xml)$"
148+
contentType = "application/xml"
149+
gzip = true
150+
force = true

‎config/comparison/production/config.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
baseURL = "https://tutorials.groupdocs.cloud/comparison"
2+
3+
# Google Tag Manager settings
4+
[params.gtm]
5+
gtm_id = "GTM-T42TVBC"
6+
7+
[[deployment.targets]]
8+
name = "Production"
9+
URL = "s3://tutorials.groupdocs.cloud/?prefix=comparison/&region=us-west-2"

‎config/comparison/staging/config.toml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
baseURL = "https://qa-tutorials.groupdocs.cloud/comparison"
2+
3+
[[deployment.targets]]
4+
name = "Stage"
5+
URL = "s3://qa-tutorials.groupdocs.cloud/?prefix=comparison /&region=us-west-2"
6+
7+
8+

‎content/comparison/english/_index.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: GroupDocs.Comparison Cloud Developer Guide | Comprehensive Implementation Instructions
3+
weight: 2
4+
description: Complete developer guide for implementing GroupDocs.Comparison Cloud API in your applications. Learn integration steps, code examples, and best practices.
5+
url: /comparison/
6+
---
7+
8+
# GroupDocs.Comparison Cloud Developer Guide
9+
10+
Welcome to the comprehensive developer guide for GroupDocs.Comparison Cloud. This guide provides detailed instructions on integrating and utilizing our powerful document comparison API in your applications.
11+
12+
## Overview
13+
14+
GroupDocs.Comparison Cloud is a REST API that allows you to compare documents across various formats and identify differences between them. This guide will walk you through the process of implementing the API in your projects, providing examples and best practices.
15+
16+
## Getting Started
17+
18+
###[Document Getting Started Tutorials](/comparison/getting-started/)
19+
20+
Learn how to use GroupDocs.Comparison Cloud API to compare various document formats
21+
22+
###[Document Advanced Features Tutorial](/comparison/advanced-features/)
23+
24+
Tutorials for implementing advanced document comparison features using GroupDocs.Comparison Cloud API for developers
25+
26+
###[Document Advanced Data Structures Tutorials](/comparison/advanced-data-structures/)
27+
28+
Tutorials for working with advanced data structures in GroupDocs.Comparison Cloud API
29+
30+
### Prerequisites
31+
32+
Before integrating GroupDocs.Comparison Cloud into your application, ensure you have:
33+
34+
- A GroupDocs.Comparison Cloud subscription or free trial
35+
- Your Client ID and Client Secret credentials
36+
- Basic understanding of REST APIs
37+
- Familiarity with your preferred programming language
38+
39+
### Authentication
40+
41+
All API requests require authentication. To authenticate:
42+
43+
1. Obtain your Client ID and Client Secret from your account dashboard
44+
2. Use these credentials to generate an access token
45+
3. Include the token in the header of all your API requests
46+
47+
```javascript
48+
// Example authentication code (JavaScript)
49+
const clientId = "YOUR_CLIENT_ID";
50+
const clientSecret = "YOUR_CLIENT_SECRET";
51+
52+
// Code to obtain access token
53+
// ...
54+
```
55+
56+
## Best Practices
57+
58+
- Always use proper error handling in your integration
59+
- Implement caching strategies for access tokens
60+
- Consider file size limitations when uploading documents
61+
- Use appropriate comparison settings based on document type
62+
- Implement retry logic for API requests
63+
64+
## API Reference
65+
66+
For a complete reference of all API endpoints and parameters, refer to our [API Reference](https://reference.groupdocs.cloud/comparison/).
67+
68+
## Support and Resources
69+
70+
- [Developer Forum](https://forum.groupdocs.cloud/c/comparison)
71+
- [Knowledge Base](https://kb.groupdocs.cloud/comparison)
72+
- [GitHub Repositories](https://github.com/groupdocs-comparison-cloud)
73+
- [Sample Applications](https://github.com/groupdocs-comparison-cloud-examples)
74+
75+
## Conclusion
76+
77+
GroupDocs.Comparison Cloud provides a powerful and flexible solution for document comparison needs. By following this developer guide, you should be able to successfully integrate and utilize the API in your applications.

0 commit comments

Comments
 (0)