Skip to content

Commit

Permalink
Fix links and add link check
Browse files Browse the repository at this point in the history
Also updating submodule to get link fixes from there
  • Loading branch information
erikbosch committed Jun 11, 2024
1 parent d72777a commit 010d271
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 4 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/check-markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# /********************************************************************************
# * Copyright (c) 2024 Contributors to the Eclipse Foundation
# *
# * See the NOTICE file(s) distributed with this work for additional
# * information regarding copyright ownership.
# *
# * This program and the accompanying materials are made available under the
# * terms of the Apache License 2.0 which is available at
# * http://www.apache.org/licenses/LICENSE-2.0
# *
# * SPDX-License-Identifier: Apache-2.0
# ********************************************************************************/

name: check-markdown

on:
push:
pull_request:
workflow_dispatch:

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
check-doc-links:
name: Check links in markdown
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
submodules: 'true'
- uses: eclipse-kuksa/kuksa-actions/check-markdown@4
4 changes: 4 additions & 0 deletions .github/workflows/dash.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ on:
branches:
- main

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
check-dash:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ More about Eclipse KUKSA can be found in the [repository](https://github.com/ecl

KUKSA Python SDK provides both a command-line interface (CLI) and a standalone library to interact with either
[KUKSA Server](https://github.com/eclipse/kuksa.val/tree/master/kuksa-val-server) or
[KUKSA Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker).
[KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker).


## Building and Installing the KUKSA Python SDK
Expand Down Expand Up @@ -45,7 +45,7 @@ For more details see the KUKSA Python SDK [Docker documentation](https://github.
## Using KUKSA Python SDK as library

The KUKSA Python SDK provides three APIS for connecting and communicating with [KUKSA Server](https://github.com/eclipse/kuksa.val/tree/master/kuksa-val-server)
and [KUKSA Databroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker).
and [KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker).
For more details see the KUKSA Python SDK [Library documentation](https://github.com/eclipse-kuksa/kuksa-python-sdk/blob/main/docs/library.md).

## Contributing to KUKSA Python SDK
Expand Down
2 changes: 1 addition & 1 deletion docs/library.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This package holds 3 different APIs depending on your application's requirements

## TLS configuration

Clients like [KUKSA CAN Feeder](https://github.com/eclipse/kuksa.val.feeders/tree/main/dbc2val)
Clients like [KUKSA CAN Provider](https://github.com/eclipse-kuksa/kuksa-can-provider)
that use KUKSA Client library must typically set the path to the root CA certificate.
If the path is set the VSSClient will try to establish a secure connection.

Expand Down
2 changes: 1 addition & 1 deletion submodules/kuksa-databroker
Submodule kuksa-databroker updated 68 files
+2 −2 .github/workflows/check_license.yml
+99 −0 .github/workflows/create_draft_release.yml
+101 −49 .github/workflows/kuksa_databroker-cli_build.yml
+86 −78 .github/workflows/kuksa_databroker_build.yml
+1 −0 .gitignore
+309 −270 Cargo.lock
+4 −4 Cargo.toml
+0 −134 DEPENDENCIES
+21 −183 NOTICE.md
+28 −21 README.md
+0 −76 build-all-targets-cli.sh
+0 −76 build-all-targets.sh
+0 −20 createbom/README.md
+0 −40 createbom/bomutil/maplicensefile.py
+0 −36 createbom/bomutil/quirks.py
+0 −201 createbom/createbom.py
+ createbom/licensestore/0BSD.txt.gz
+ createbom/licensestore/Apache-2.0.txt.gz
+ createbom/licensestore/BSD-2-Clause.txt.gz
+ createbom/licensestore/BSD-3-Clause.txt.gz
+ createbom/licensestore/BSL-1.0.txt.gz
+ createbom/licensestore/BlueOak-1.0.0.md.gz
+ createbom/licensestore/CC0-1.0.txt.gz
+ createbom/licensestore/ISC.txt.gz
+ createbom/licensestore/MIT.txt.gz
+ createbom/licensestore/Unicode-DFS-2016.txt.gz
+ createbom/licensestore/Unlicense.txt.gz
+ createbom/licensestore/WTFPL.txt.gz
+ createbom/licensestore/Zlib.txt.gz
+ createbom/licensestore/ring.LICENSE.txt.gz
+ createbom/licensestore/webpki.LICENSE.txt.gz
+4 −4 data/vss-core/README.md
+4 −1 databroker-cli/Cargo.toml
+6 −4 databroker-cli/src/cli.rs
+13 −14 databroker-cli/src/kuksa_cli.rs
+4 −4 databroker-cli/src/main.rs
+20 −23 databroker-cli/src/sdv_cli.rs
+1 −1 databroker-proto/Cargo.toml
+6 −2 databroker/Cargo.toml
+20 −5 databroker/src/broker.rs
+1,413 −0 databroker/src/glob.rs
+631 −151 databroker/src/grpc/kuksa_val_v1/val.rs
+5 −5 databroker/src/grpc/sdv_databroker_v1/collector.rs
+33 −12 databroker/src/grpc/server.rs
+16 −3 databroker/src/main.rs
+1 −1 databroker/tests/read_write_values.rs
+2 −1 databroker/tests/world/mod.rs
+40 −40 doc/protocol/README.md
+18 −14 doc/quickstart.md
+2 −2 doc/system-architecture.md
+1 −1 doc/terminology.md
+2 −2 doc/tls.md
+54 −33 doc/user_guide.md
+9 −0 doc/wildcard_matching.md
+1 −1 integration_test/run.sh
+185 −193 lib/Cargo.lock
+1 −1 lib/common/Cargo.toml
+1 −1 lib/kuksa/Cargo.toml
+1 −1 lib/sdv/Cargo.toml
+1 −1 proto/kuksa/val/v1/README.md
+14 −3 proto/kuksa/val/v1/val.proto
+3 −3 proto/sdv/databroker/v1/README.md
+14 −10 scripts/Dockerfile
+9 −9 scripts/Dockerfile-cli
+149 −0 scripts/build-databroker-cli.sh
+155 −0 scripts/build-databroker.sh
+22 −0 scripts/licensecuration.yaml
+25 −5 scripts/prepare_release.sh

0 comments on commit 010d271

Please sign in to comment.