Skip to content

Commit efd7a3e

Browse files
committed
README: Update introduction links
Update introduction links
1 parent 014a648 commit efd7a3e

File tree

2 files changed

+38
-18
lines changed

2 files changed

+38
-18
lines changed

.github/workflows/linter-documentation-links.yml

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ jobs:
2020
workflowfile=linter-documentation-links.yml
2121
2222
# Version specific URL strings
23-
acap3_type_urls="help.axis.com/acap-3-developer-guide \
24-
www.axis.com/techsup/developer_doc"
23+
acap3_base_url="axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3"
24+
acap3_type_urls="$acap3_base_url www.axis.com/techsup/developer_doc"
2525
acap4_type_urls="axiscommunications.github.io/acap-documentation"
2626
2727
# Decide which SDK version this repo is
@@ -32,26 +32,41 @@ jobs:
3232
*acap-native-sdk-examples*)
3333
search_urls=$acap3_type_urls
3434
incorrect_sdk_version=3
35+
36+
# Check for incorrect URLs
37+
set +e
38+
found_error=n
39+
for doc_url in $search_urls
40+
do
41+
found_doc_url=$(grep -nir "$doc_url" --exclude $workflowfile)
42+
[ -z "$found_doc_url" ] || {
43+
printf "\nERROR: $doc_url is an ACAP $incorrect_sdk_version documentation URL found in:\n$found_doc_url\n"
44+
found_error=y
45+
}
46+
done
47+
set -e
48+
3549
;;
3650
*acap3-examples*)
3751
search_urls=$acap4_type_urls
3852
incorrect_sdk_version=4
53+
54+
# Check for incorrect URLs
55+
set +e
56+
found_error=n
57+
for doc_url in $search_urls
58+
do
59+
found_doc_url=$(grep -nir "$doc_url" --exclude $workflowfile | grep -v $acap3_base_url)
60+
[ -z "$found_doc_url" ] || {
61+
printf "\nERROR: $doc_url is an ACAP $incorrect_sdk_version documentation URL found in:\n$found_doc_url\n"
62+
found_error=y
63+
}
64+
done
65+
set -e
66+
3967
;;
4068
esac
4169
42-
# Check for incorrect URLs
43-
set +e
44-
found_error=n
45-
for doc_url in $search_urls
46-
do
47-
found_doc_url=$(grep -nir "$doc_url" --exclude $workflowfile)
48-
[ -z "$found_doc_url" ] || {
49-
printf "\nERROR: $doc_url is an ACAP $incorrect_sdk_version documentation URL found in:\n$found_doc_url\n"
50-
found_error=y
51-
}
52-
done
53-
set -e
54-
5570
if [ $found_error = n ]; then
5671
printf "\nNo ACAP $incorrect_sdk_version documentation URL was found -> PASS"
5772
else

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@
66
- Business intelligence applications that improve business efficiency.
77
- Camera feature plug-ins that add value beyond the Axis product's core functionality
88

9-
# Prerequisites for ACAP development
9+
## ACAP SDK version 3
1010

11-
ACAP is Axis own open platform for applications that run on-board an Axis product. If you are new to ACAP, start with learning more about the platform, [prerequisites](https://www.axis.com/developer-community/acap-fundamentals), [compatible architectures](https://www.axis.com/developer-community/acap-sdk) and [SDK user manual](https://help.axis.com/acap-3-developer-guide).
11+
ACAP is Axis own open platform for applications that run on-board an Axis
12+
product. If you are new to ACAP, start with learning more about the platform:
1213

13-
# Getting started with the repository
14+
- [AXIS ACAP 3 SDK Documentation](https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3)
15+
- [Introduction](https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/introduction)
16+
- [Getting Started](https://axiscommunications.github.io/acap-documentation/docs/acap-sdk-version-3/get-started)
17+
18+
## Getting started with the repository
1419

1520
This repository contains a set of application examples which aims to enrich the
1621
developers analytics experience. All examples are using Docker framework and

0 commit comments

Comments
 (0)