Skip to content

Commit

Permalink
polish documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
madelen-axis committed Nov 10, 2023
1 parent e3eed8f commit 20ab7be
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 78 deletions.
7 changes: 7 additions & 0 deletions .vscode/extensions.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"DavidAnson.vscode-markdownlint",
"editorconfig.editorconfig",
"streetsidesoftware.code-spell-checker"
]
}
17 changes: 17 additions & 0 deletions .vscode/settings.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"C_Cpp.clang_format_style": "file",
"[markdown]": {
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
"editor.formatOnSave": true,
"editor.formatOnPaste": true
},
"markdown.extension.list.indentationSize": "inherit",
"markdown.extension.toc.levels": "1..3",
"cSpell.words": [
"anyauth",
"Buildx",
"containerd",
"rootpasswd",
"VAPIX"
]
}
112 changes: 61 additions & 51 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
<!-- omit in toc -->
# Regarding contributions

All types of contributions are encouraged and valued. See the [Table of contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. We look forward to your contributions.
All types of contributions are encouraged and valued. See the [Table of contents](#table-of-contents)
for different ways to help and details about how this project handles them. Please make sure to read
the relevant section before making your contribution. It will make it a lot easier for us maintainers
and smooth out the experience for all involved. We look forward to your contributions.

> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> And if you like the project, but just don't have time to contribute, that's fine. There are other
> easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Tweet about it
Expand All @@ -16,21 +20,15 @@ All types of contributions are encouraged and valued. See the [Table of contents
- [I have a question](#i-have-a-question)
- [I want to contribute](#i-want-to-contribute)
- [Reporting bugs](#reporting-bugs)
- [Before submitting a bug report](#before-submitting-a-bug-report)
- [How do I submit a good bug report?](#how-do-i-submit-a-good-bug-report)
- [Suggesting enhancements](#suggesting-enhancements)
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
- [How do I submit a good enhancement suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
- [Your first code contribution](#your-first-code-contribution)
- [Test of codebase](#test-of-codebase)
- [Lint of codebase](#lint-of-codebase)
- [Linters in GitHub Action](#linters-in-github-action)
- [Run super-linter locally](#run-super-linter-locally)
- [Run super-linter interactively](#run-super-linter-interactively)

## I have a question

Before you ask a question, it is best to search for existing [issues][issues] that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
Before you ask a question, it is best to search for existing [issues][issues] that might help you.
In case you have found a suitable issue and still need clarification, you can write your question in
this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, please
follow the steps in [Reporting bugs](#reporting-bugs).
Expand All @@ -41,18 +39,24 @@ follow the steps in [Reporting bugs](#reporting-bugs).

#### Before submitting a bug report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible:
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we
ask you to investigate carefully, collect information and describe the issue in detail in your report.
Please complete the following steps in advance to help us fix any potential bug as fast as possible:

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions.
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker][issues_bugs].
- Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
components/versions.
- To see if other users have experienced (and potentially already solved) the same issue you are having,
check if there is not already a bug report existing for your bug or error in the [bug tracker][issues_bugs].
- Also make sure to search the internet to see if users outside of the GitHub community have discussed
the issue.
- Collect information about the bug:
- Axis device model
- Axis device firmware version
- Stack trace
- OS and version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what
seems relevant
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

Expand All @@ -62,39 +66,53 @@ We use GitHub issues to track bugs and errors. If you run into an issue with the

- Open an [issue][issues_new].
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own.
- Please provide as much context as possible and describe the *reproduction steps* that someone else
can follow to recreate the issue on their own.
- Provide the information you collected in the previous section.

Once it's filed:

- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. Bugs without steps will not be addressed until they can be reproduced.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction
steps or no obvious way to reproduce the issue, the team will ask you for those steps. Bugs without
steps will not be addressed until they can be reproduced.
- If the team is able to reproduce the issue, it will be prioritized according to severity.

### Suggesting enhancements

This section guides you through submitting an enhancement suggestion, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
This section guides you through submitting an enhancement suggestion,
**including completely new features and minor improvements to existing functionality**.
Following these guidelines will help maintainers and the community to understand your suggestion and
find related suggestions.

#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search][issues] to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an
individual configuration.
- Perform a [search][issues] to see if the enhancement has already been suggested. If it has, add a
comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. Keep in mind that we want
features that will be useful to the majority of our users and not just a small subset.

#### How do I submit a good enhancement suggestion?

Enhancement suggestions are tracked as [GitHub issues][issues].

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
- **Explain why this enhancement would be useful** to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or
point out the part which the suggestion is related to.
- **Explain why this enhancement would be useful** to most users. You may also want to point out the
other projects that solved it better and which could serve as inspiration.

### Your first code contribution

Start by [forking the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo), i.e. copying the repository to your account to grant you write access. Continue with cloning the forked repository to your local machine.
Start by [forking the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo),
i.e. copying the repository to your account to grant you write access. Continue with cloning the
forked repository to your local machine.

```sh
git clone https://github.com/<your username>/AxisCommunications/acap-runtime.git
Expand All @@ -107,7 +125,8 @@ cd acap-runtime
git switch -c <branch name>
```

Update the code according to your requirements, and commit the changes using the [conventional commits](https://www.conventionalcommits.org) message style:
Update the code according to your requirements, and commit the changes using the
[conventional commits](https://www.conventionalcommits.org) message style:

```sh
git commit -a -m 'Follow the conventional commit messages style to write this message'
Expand All @@ -124,38 +143,28 @@ Before opening a Pull Request (PR), please consider the following guidelines:
- Please make sure that the code builds perfectly fine on your local system.
- Make sure that all linters pass, see [Lint of codebase](#lint-of-codebase)
- The PR will have to meet the code standard already available in the repository.
- Explanatory comments related to code functions are required. Please write code comments for a better understanding of the code for other developers.
- Explanatory comments related to code functions are required. Please write code comments for a better
understanding of the code for other developers.
- Note that code changes or additions to the `.github` folder (or sub-folders) will not be accepted.

And finally when you are satisfied with your changes, open a new PR.

### Test of codebase

The repo has a CI/CD workflow setup that includes testing of the codebase. The steps of the workflow are, for each architecture:

1. Build the ACAP Runtime [test suite][test-suite] Docker image and push to Docker Hub.
2. Pull the test suite Docker image and run it on an external device.
3. Build the ACAP Runtime Docker image and push to Docker Hub.
4. Build the ACAP Runtime containerized Docker image and push to Docker Hub.

The workflow should be possible to run from a fork with the following updates:

- Create your own Docker repository and refer to it in the workflow. Make sure to add your own secrets for login to the repository.
- Setup devices to test on and update the workflow with their IP addresses and provide secrets for the user name and login to the devices.

### Lint of codebase

A set of different linters test the codebase and these must pass in order to get a pull request approved.

#### Linters in GitHub Action

When you create a pull request, a set of linters will run syntax and format checks on different file types in GitHub actions by making use of a tool called [super-linter][super-linter]. If any of the linters gives an error, this will be shown in the action connected to the pull request.
When you create a pull request, a set of linters will run syntax and format checks on different file
types in GitHub actions by making use of a tool called [super-linter][super-linter]. If any of the
linters gives an error, this will be shown in the action connected to the pull request.

In order to speed up development, it's possible to run linters as part of your local development environment.

#### Run super-linter locally

Since super-linter is using a Docker image in GitHub Actions, users of other editors may run it locally to lint the codebase. For complete instructions and guidance, see super-linter page for [running locally][super-linter-local].
Since super-linter is using a Docker image in GitHub Actions, users of other editors may run it locally
to lint the codebase. For complete instructions and guidance, see super-linter page for [running locally][super-linter-local].

To run a number of linters on the codebase from command line:

Expand Down Expand Up @@ -186,7 +195,8 @@ docker run --rm \
-it github/super-linter:slim-v4
```

Then from the container terminal, the following commands can lint the the code base for different file types:
Then from the container terminal, the following commands can lint the the code base for different
file types:

```sh
# Lint Dockerfile files
Expand All @@ -206,10 +216,10 @@ shfmt -d .
To lint only a specific file, replace `.` or `$(COMMAND)` with the file path.

<!-- markdownlint-disable MD034 -->
[issues]: https://github.com/AxisCommunications/acap-runtime/issues
[issues_new]: https://github.com/AxisCommunications/acap-runtime/issues/new
[issues_bugs]: https://github.com/AxisCommunications/acap-runtime/issues?q=label%3Abug
[super-linter]: https://github.com/github/super-linter
[super-linter-local]: https://github.com/github/super-linter/blob/main/docs/run-linter-locally.md
[test-suite]: https://github.com/AxisCommunications/acap-runtime#test-suite
[issues]: https://github.com/AxisCommunications/docker-compose-acap/issues
[issues_new]: https://github.com/AxisCommunications/docker-compose-acap/issues/new
[issues_bugs]: https://github.com/AxisCommunications/docker-compose-acap/issues?q=label%3Abug
[super-linter]: https://github.com/super-linter/super-linter
[super-linter-local]: https://github.com/super-linter/super-linter/blob/main/docs/run-linter-locally.md

<!-- markdownlint-enable MD034 -->
47 changes: 20 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,19 @@ device. In addition it bundles the docker CLI and the docker Compose CLI.
<!-- omit in toc -->
## Table of contents

- [Overview](#overview)
- [Requirements](#requirements)
- [Installation and Usage](#installation-and-usage)
- [Installation](#installation)
- [Securing the Docker Compose ACAP using TLS](#securing-the-docker-compose-acap-using-tls)
- [TLS Setup](#tls-setup)
- [The Certificate Authority (CA) certificate](#the-certificate-authority-ca-certificate)
- [The server certificate](#the-server-certificate)
- [The private server key](#the-private-server-key)
- [Client key and certificate](#client-key-and-certificate)
- [Using an SD card as storage](#using-an-sd-card-as-storage)
- [Using the Docker Compose ACAP](#using-the-docker-compose-acap)
- [Using the Docker Compose ACAP on the Axis device](#using-the-docker-compose-acap-on-the-axis-device)
- [Using the Docker Compose ACAP remotely](#using-the-docker-compose-acap-remotely)
- [Test that the Docker ACAP can run a container](#test-that-the-docker-acap-can-run-a-container)
- [Loading images onto a device](#loading-images-onto-a-device)
- [Building the Docker Compose ACAP](#building-the-docker-compose-acap)
- [Installing a locally built Docker Compose ACAP](#installing-a-locally-built-docker-compose-acap)
- [Contributing](#contributing)
- [License](#license)
* [Overview](#overview)
* [Requirements](#requirements)
* [Installation and Usage](#installation-and-usage)
* [Installation](#installation)
* [Securing the Docker Compose ACAP using TLS](#securing-the-docker-compose-acap-using-tls)
* [Using an SD card as storage](#using-an-sd-card-as-storage)
* [Using the Docker Compose ACAP](#using-the-docker-compose-acap)
* [Using the Docker Compose ACAP on the Axis device](#using-the-docker-compose-acap-on-the-axis-device)
* [Using the Docker Compose ACAP remotely](#using-the-docker-compose-acap-remotely)
* [Building the Docker Compose ACAP](#building-the-docker-compose-acap)
* [Installing a locally built Docker Compose ACAP](#installing-a-locally-built-docker-compose-acap)
* [Contributing](#contributing)
* [License](#license)

## Overview

Expand All @@ -69,11 +62,11 @@ the Docker Compose ACAP application.

The following requirements need to be met.

- Axis device:
- Axis OS version 11.7 or higher.
- The device needs to have ACAP Native SDK support. See [Axis devices & compatibility][devices]
* Axis device:
* Axis OS version 11.7 or higher.
* The device needs to have ACAP Native SDK support. See [Axis devices & compatibility][devices]
for more information.
- Additionally, the device must be container capable. To check the compatibility
* Additionally, the device must be container capable. To check the compatibility
of your device run:

```sh
Expand All @@ -89,10 +82,10 @@ ssh root@$DEVICE_IP 'command -v containerd >/dev/null 2>&1 && echo Compatible wi
where `<device ip>` is the IP address of the Axis device and `<password>` is the root password. Please
note that you need to enclose your password with quotes (`'`) if it contains special characters.

- Computer:
- Either [Docker Desktop][dockerDesktop] version 4.11.1 or higher, or
* Computer:
* Either [Docker Desktop][dockerDesktop] version 4.11.1 or higher, or
[Docker Engine][dockerEngine] version 20.10.17 or higher.
- To build Docker Compose ACAP locally it is required to have [Buildx][buildx] installed.
* To build Docker Compose ACAP locally it is required to have [Buildx][buildx] installed.

## Installation and Usage

Expand Down

0 comments on commit 20ab7be

Please sign in to comment.