Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .github/workflows/comparison-production.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# This is a basic workflow to help you get started with Actions

name: tutorials.groupdocs.cloud(comparison)(family)(Production)

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
paths:
- 'content/comparison/**'
pull_request:
branches: [ master ]
paths:
- 'content/comparison/**'

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of comparison that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout
uses: actions/checkout@v2
with:
submodules: true # Fetch Hugo themes
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
- name: Checkout theme repo
uses: actions/checkout@main
with:
repository: groupdocs-cloud/tutorials-theme
token: ${{ secrets.REPO_TOKEN }}
fetch-depth: 0
path: themes/tutorials-theme
# Step 2 - Sets up the latest version of Hugo
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.135.0'
extended: true
- name: Install Dependicies1
run: npm install -D --save autoprefixer
- name: Install Dependicies2
run: npm install -D --save postcss-cli
# Also specifies the theme we want to use
- name: Build
run: hugo --configDir config/comparison --environment production --minify

- name: Deploy tutorials.groupdocs.cloud(comparison)(family)(Production) to S3
run: hugo --configDir config/comparison --environment production deploy --target "Production" --maxDeletes 0
env:
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}
# Invalidate Cloudfront
- name: invalidate
uses: chetan/invalidate-cloudfront-action@v2
env:
DISTRIBUTION: ${{ secrets.AWS_DISTRIBUTION_PROD }}
PATHS: /comparison/*
AWS_REGION: 'us-west-2'
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}
69 changes: 69 additions & 0 deletions .github/workflows/comparison-staging.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# This is a basic workflow to help you get started with Actions

name: qa-tutorials.groupdocs.cloud(comparison)(family)(Stage)

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ staging ]
paths:
- 'content/comparison/**'
pull_request:
branches: [ staging ]
paths:
- 'content/comparison/**'

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of comparison that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout
uses: actions/checkout@v2
with:
submodules: true # Fetch Hugo themes
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
- name: Checkout theme repo
uses: actions/checkout@main
with:
repository: groupdocs-cloud/tutorials-theme
token: ${{ secrets.REPO_TOKEN }}
fetch-depth: 0
path: themes/tutorials-theme
# Step 2 - Sets up the latest version of Hugo
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.135.0'
extended: true
- name: Install Dependicies1
run: npm install -D --save autoprefixer
- name: Install Dependicies2
run: npm install -D --save postcss-cli
# Also specifies the theme we want to use
- name: Build
run: hugo --configDir config/comparison --environment staging --minify

- name: Deploy qa-tutorials.groupdocs.cloud(comparison)(family)(Stage) to S3
run: hugo --configDir config/comparison --environment staging deploy --target "Stage" --maxDeletes 0
env:
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}
# Invalidate Cloudfront
- name: invalidate
uses: chetan/invalidate-cloudfront-action@v2
env:
DISTRIBUTION: ${{ secrets.AWS_DISTRIBUTION }}
PATHS: /comparison/*
AWS_REGION: 'us-west-2'
AWS_ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.SECRET_ACCESS }}
150 changes: 150 additions & 0 deletions config/comparison/_default/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
baseURL = "/comparison"
title = "GroupDocs Cloud Tutorials"
staticdir = 'content/static'
enableRobotsTXT = true
enableGitInfo = true
disableKinds = ["taxonomy", "taxonomyTerm", "page", "RSS"]

# Hugo allows theme composition (and inheritance). The precedence is from left to right.
theme = ["tutorials-theme"]

[params.menu]
zh = "groupdocscloud-zh"
ru = "groupdocscloud-ru"
ar = "groupdocscloud-ar"
cs = "groupdocscloud-cs"
de = "groupdocscloud-de"
el = "groupdocscloud-el"
es = "groupdocscloud-es"
fr = "groupdocscloud-fr"
hi = "groupdocscloud-hi"
hu = "groupdocscloud-hu"
id = "groupdocscloud-id"
it = "groupdocscloud-it"
ja = "groupdocscloud-ja"
ko = "groupdocscloud-ko"
nl = "groupdocscloud-nl"
pl = "groupdocscloud-pl"
pt = "groupdocscloud-pt"
sv = "groupdocscloud-sv"
th = "groupdocscloud-th"
tr = "groupdocscloud-tr"
vi = "groupdocscloud-vi"
zh-hant = "groupdocscloud-zht"

defaultContentLang = 'en'
[languages]
[languages.en]
contentDir = 'content/comparison/english'
languageName = 'English'
languageCode = "en"
flag = "flag-us"
weight = 10

ignoreFiles = ["(?i:readme.md)", '\.spin$']

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
# id = "UA-00000000-0"

[markup]
[markup.tableOfContents]
endLevel = 2
ordered = true
startLevel = 2
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
anchorLineNos = false
codeFences = true
guessSyntax = false
hl_Lines = ""
lineAnchors = ""
lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = false
tabWidth = 4

# Everything below this are Site Params

[params]
copyright = "The GroupDocs Cloud Authors"
privacy_policy = "https://policies.google.com/privacy"
topbar_search_active = false
logo_rel_link = ""

# Containerize Menu
[params.containerize]
menu = "groupdocscloud-en"

[params.meta]
msapplication_TileColor = "#2b5797"
msapplication_config = "https://cms.admin.containerize.com/templates/groupdocscloud/images/browserconfig.xml"
theme_color = "#ffffff"
author = "GroupDocs Cloud"

# Title of 404 page
title_404_page = "404 - Page Not Found | GroupDocs Cloud Tutorials"

# Open Grapgh settings
title = "GroupDocs Cloud Tutorials"
images = ["images/aspose-cloud-image-for-open-graph.jpg"]
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"


# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = true
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = false
# Set to true to disable the About link in the site footer
footer_about_disable = false


[minify]
disableCSS = false
disableHTML = false
disableJS = false
disableJSON = false
disableSVG = false
disableXML = false
minifyOutput = true
[minify.tdewolff]
[minify.tdewolff.css]
decimals = -1
keepCSS2 = true
[minify.tdewolff.html]
keepConditionalComments = true
keepDefaultAttrVals = true
keepDocumentTags = true
keepEndTags = true
keepQuotes = false
keepWhitespace = false
[minify.tdewolff.js]
[minify.tdewolff.json]
[minify.tdewolff.svg]
decimals = -1
[minify.tdewolff.xml]
keepWhitespace = false

[Taxonomies]

[deployment]
[[deployment.matchers]]
# Set custom content type for /sitemap.xml
#pattern = "^sitemap\\.xml$"
#pattern = "^[a-z]\\.xml$"
pattern = "^.+\\.(xml)$"
contentType = "application/xml"
gzip = true
force = true
9 changes: 9 additions & 0 deletions config/comparison/production/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
baseURL = "https://tutorials.groupdocs.cloud/comparison"

# Google Tag Manager settings
[params.gtm]
gtm_id = "GTM-T42TVBC"

[[deployment.targets]]
name = "Production"
URL = "s3://tutorials.groupdocs.cloud/?prefix=comparison/&region=us-west-2"
8 changes: 8 additions & 0 deletions config/comparison/staging/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
baseURL = "https://qa-tutorials.groupdocs.cloud/comparison"

[[deployment.targets]]
name = "Stage"
URL = "s3://qa-tutorials.groupdocs.cloud/?prefix=comparison /&region=us-west-2"



77 changes: 77 additions & 0 deletions content/comparison/english/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: GroupDocs.Comparison Cloud Developer Guide | Comprehensive Implementation Instructions
weight: 2
description: Complete developer guide for implementing GroupDocs.Comparison Cloud API in your applications. Learn integration steps, code examples, and best practices.
url: /comparison/
---

# GroupDocs.Comparison Cloud Developer Guide

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.

## Overview

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.

## Getting Started

###[Document Getting Started Tutorials](/comparison/getting-started/)

Learn how to use GroupDocs.Comparison Cloud API to compare various document formats

###[Document Advanced Features Tutorial](/comparison/advanced-features/)

Tutorials for implementing advanced document comparison features using GroupDocs.Comparison Cloud API for developers

###[Document Advanced Data Structures Tutorials](/comparison/advanced-data-structures/)

Tutorials for working with advanced data structures in GroupDocs.Comparison Cloud API

### Prerequisites

Before integrating GroupDocs.Comparison Cloud into your application, ensure you have:

- A GroupDocs.Comparison Cloud subscription or free trial
- Your Client ID and Client Secret credentials
- Basic understanding of REST APIs
- Familiarity with your preferred programming language

### Authentication

All API requests require authentication. To authenticate:

1. Obtain your Client ID and Client Secret from your account dashboard
2. Use these credentials to generate an access token
3. Include the token in the header of all your API requests

```javascript
// Example authentication code (JavaScript)
const clientId = "YOUR_CLIENT_ID";
const clientSecret = "YOUR_CLIENT_SECRET";

// Code to obtain access token
// ...
```

## Best Practices

- Always use proper error handling in your integration
- Implement caching strategies for access tokens
- Consider file size limitations when uploading documents
- Use appropriate comparison settings based on document type
- Implement retry logic for API requests

## API Reference

For a complete reference of all API endpoints and parameters, refer to our [API Reference](https://reference.groupdocs.cloud/comparison/).

## Support and Resources

- [Developer Forum](https://forum.groupdocs.cloud/c/comparison)
- [Knowledge Base](https://kb.groupdocs.cloud/comparison)
- [GitHub Repositories](https://github.com/groupdocs-comparison-cloud)
- [Sample Applications](https://github.com/groupdocs-comparison-cloud-examples)

## Conclusion

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.
Loading