Verify/markdown

.github/ISSUE_TEMPLATE/user_story.md

@@ -1,10 +1,8 @@
 ---
 name: User Story
 about: User Story
-labels: 
+labels:
 title: <User Story> - Title
-
-
 ---
 
 **User Story**: The expressive title of your user story goes here
@@ -15,13 +13,15 @@ As a [type of user], I want to [perform some task] so that I can [achieve some g
 This is a short text that just acts as an example for your user story. Please be as precise and verbose as required, so that people picking up the user story are clear about the intention and their tasks.
 
 **Epic link**:
-- #410 (just mention the number of the related epic here, it will appear as clickable link later)  
+
+- #410 (just mention the number of the related epic here, it will appear as clickable link later)
 
 **Acceptance criteria**:
 
-- [ ] abc should have a red button in the center of the screen 
+- [ ] abc should have a red button in the center of the screen
 - [ ] on clicking the red button it should start to blink
 
 **Related issues**:
-- #413 (just mention the number of the related issue here, it will appear as clickable link later)  
-- #414 (just mention the number of the related issue here, it will appear as clickable link later)  
+
+- #413 (just mention the number of the related issue here, it will appear as clickable link later)
+- #414 (just mention the number of the related issue here, it will appear as clickable link later)

.github/workflows/lint_and_test.yaml

@@ -39,8 +39,8 @@ jobs:
         run: |
           PATH=$PATH:$(go env GOPATH)/bin make build install-requirements test
 
-  lint:
-    name: Lint
+  go-lint:
+    name: Lint Golang
     runs-on: large_runner
     steps:
       - name: Checkout

.github/workflows/reuse_helper_tool.yaml

@@ -3,7 +3,7 @@ name: REUSE Compliance Check
 on: [push, pull_request]
 
 jobs:
-  test:
+  reuse:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4

.github/workflows/verify-md.yml

@@ -0,0 +1,47 @@
+name: Markdown
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**/*.md'
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+    name: Lint Markdown
+    steps:
+      - uses: actions/checkout@v4
+      - name: Markdown Linting
+        uses: nosborn/github-action-markdown-cli@v3
+        with:
+          files: .
+          dot: true
+          config_file: .markdownlint.yml
+          ignore_path: .markdownignore
+  verify-links:
+    name: Verify links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Markdown verify links
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: yes
+          use-verbose-mode: no
+          config-file: .markdown-link-check.json
+  spellcheck:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Spellcheck
+        uses: rojopolis/spellcheck-github-actions@v0
+        with:
+          task_name: Markdown
+          output_file: spellcheck-output.txt
+

.markdown-link-check.json

@@ -0,0 +1,8 @@
+{ "replacementPatterns": [
+     { "pattern": "^/", "replacement": "{{BASEURL}}/" }
+  ],
+  "ignorePatterns": [
+     { "pattern": "^http[s]*://localhost.*" }
+    ,{ "pattern": "^{{.*}}$" }
+  ]
+}

.markdownignore

@@ -0,0 +1,3 @@
+examples/lib/tour/0*
+docs/reference
+docs/pluginreference

.markdownlint.yml

@@ -0,0 +1,4 @@
+default: true
+
+MD013: false #Line length - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013
+MD033: false #Inline HTML - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033

.spellcheck.yml

@@ -0,0 +1,20 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - pymdownx.superfences
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8

.wordlist.txt

@@ -0,0 +1,153 @@
+aggregative
+API
+ArtifactId
+AWS
+backend
+backends
+basename
+bool
+boolean
+CAs
+CLI
+CLIs
+closable
+CNCF
+ConsumerId
+crypto
+CTF
+CTFs
+CVs
+dependabot
+deserializable
+deserialization
+deserialize
+deserialized
+digesters
+DNS
+DockerConfig
+downloader
+downloaders
+dry-run
+echoserver
+entrypoint
+executables
+extensibility
+filepath
+filesystem
+finalizer
+finalizers
+foldername
+GAV
+getter
+Github
+gitignore
+GitOps
+globals
+gofmt
+golang
+golangci
+goreleaser
+gosec
+goutils
+GroupId
+gzip
+HashiCorp
+Homebrew
+html
+http
+https
+ImageMapping
+inlined
+installable
+instantiation
+io
+iterable
+JSON
+keyless
+keyring
+kubebuilder
+kubeconfig
+Kubernetes
+lifecycle
+linter
+linters
+lister
+listers
+localizations
+lookups
+Makefile
+makefiles
+mandelsoft
+matcher
+matchers
+mavenArtifact
+mavenPackage
+mavenRepository
+mimetype
+multiarch
+mutex
+mvn
+namespace
+namespaces
+npm
+npmrc
+NpmRegistry
+oauth
+OCI
+ociArtifact
+ociRegistry
+OCM
+OCMBot
+OS
+parameterization
+podinfo
+Podman
+predefine
+programmatically
+PRs
+PubSub
+README
+readonly
+resolvers
+routings
+RSA
+runtime
+SBOD
+SBOM
+SDK
+SemVer
+sequent
+serializable
+SHA
+SPDX
+srcRefs
+stderr
+stdin
+stdout
+storable
+struct
+subchart
+subcharts
+tempfile
+templated
+templater
+templaters
+templating
+TGZ
+TLS
+TOI
+toiExecutor
+transportarchive
+typename
+unmodifiable
+untrusted
+uploader
+uploaders
+URL
+urls
+UTF
+util
+utils
+wget
+XML
+YAML

README.md

@@ -1,24 +1,24 @@
 # Open Component Model
 
 [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7156/badge)](https://bestpractices.coreinfrastructure.org/projects/7156)
-[![REUSE status](https://api.reuse.software/badge/ocm.software/ocm)](https://api.reuse.software/info/ocm.software/ocm)
-[![OCM Integration Tests](https://ocm.software/ocm-integrationtest/actions/workflows/integrationtest.yaml/badge.svg?branch=main)](https://open-component-model.github.io/ocm-integrationtest/report.html)
+[![REUSE status](https://api.reuse.software/badge/github.com/open-component-model/ocm)](https://api.reuse.software/info/github.com/open-component-model/ocm)
+[![OCM Integration Tests](https://github.com/open-component-model/ocm-integrationtest/actions/workflows/integrationtest.yaml/badge.svg?branch=main)](https://open-component-model.github.io/ocm-integrationtest/report.html)
 [![Go Report Card](https://goreportcard.com/badge/ocm.software/ocm)](https://goreportcard.com/report/ocm.software/ocm)
 
 The Open Component Model (OCM) is an open standard to describe software bills of delivery (SBOD). OCM is a technology-agnostic and machine-readable format focused on the software artifacts that must be delivered for software products.
 
-Check out the [the main OCM project web page](https://ocm.software) to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related [docs and guides](https://ocm.software/docs/overview/about), the [OCM specification](https://ocm.software/docs/overview/specification/) and all project [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/) to quickly make your hands dirty with OCM, its toolset and concepts :smiley:
+Check out the [the main OCM project web page](https://ocm.software) to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related [docs and guides](https://ocm.software/docs/overview/about), the [OCM specification](https://ocm.software/docs/overview/specification/) and all project [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/) to quickly make your hands dirty with OCM, its tool set and concepts :smiley:
 
 ## OCM Specifications
 
-OCM describes delivery [artifacts](https://ocm.software/ocm-spec/tree/main/doc/01-model/02-elements-toplevel.md#artifacts-resources-and-sources) that can be accessed from many types of [component repositories](https://ocm.software/ocm-spec/tree/main/doc/01-model/01-model.md#component-repositories). It defines a set of semantic, formatting, and other types of specifications that can be found in the [`ocm-spec` repository](https://ocm.software/ocm-spec). Start learning about the core concepts of OCM elements [here](https://ocm.software/ocm-spec/tree/main/doc/01-model/02-elements-toplevel.md#model-elements).
+OCM describes delivery [artifacts](https://github.com/open-component-model/ocm-spec/tree/main/doc/01-model/02-elements-toplevel.md#artifacts-resources-and-sources) that can be accessed from many types of [component repositories](https://github.com/open-component-model/ocm-spec/tree/main/doc/01-model/01-model.md#component-repositories). It defines a set of semantic, formatting, and other types of specifications that can be found in the [`ocm-spec` repository](https://github.com/open-component-model/ocm-spec). Start learning about the core concepts of OCM elements [here](https://github.com/open-component-model/ocm-spec/tree/main/doc/01-model/02-elements-toplevel.md#model-elements).
 
 ## OCM Library
 
 This project provides a Go library containing an API for interacting with the
-[Open Component Model (OCM)](https://ocm.software/ocm-spec) elements and mechanisms.
+[Open Component Model (OCM)](https://github.com/open-component-model/ocm-spec) elements and mechanisms.
 
-The library currently supports the following [repository mappings](https://ocm.software/ocm-spec/tree/main/doc/03-persistence/02-mappings.md#mappings-for-ocm-persistence):
+The library currently supports the following [repository mappings](https://github.com/open-component-model/ocm-spec/tree/main/doc/03-persistence/02-mappings.md#mappings-for-ocm-persistence):
 
 - **OCI**: Use the repository prefix path of an OCI repository to implement an OCM
   repository.
@@ -36,16 +36,14 @@ Additionally, OCM provides a generic solution for how to:
 - Transport component versions, per reference or as values to any of the
   repository implementations.
 
-## OCM CLI
+## [OCM CLI](docs/reference/ocm.md)
 
 The [`ocm` CLI](docs/reference/ocm.md) may also be used to interact with OCM mechanisms. It makes it easy to create component versions and embed them in build processes.
 
-The `ocm` CLI documentation can be found [here](<(https://ocm.software/ocm/blob/main/docs/reference/ocm.md)>).
-
-The code for the CLI can be found in [package `cmds/ocm`](https://ocm.software/ocm/blob/main/cmds/ocm).
+The code for the CLI can be found in [package `cmds/ocm`](cmds/ocm).
 
 The OCI and OCM support can be found in packages
-[`pkg/contexts/oci`](pkg/contexts/oci) and [`api/ocm`](api/ocm).
+[`api/oci`](api/oci) and [`api/ocm`](api/ocm).
 
 ## Installation
 
@@ -56,7 +54,7 @@ Install the latest release from any of
 - [AUR](https://aur.archlinux.org/packages/ocm-cli)
 - [Docker](https://www.docker.com/)
 - [Podman](https://podman.io/)
-- [GitHub Releases](https://ocm.software/ocm/releases)
+- [GitHub Releases](https://github.com/open-component-model/ocm/releases)
 
 ### Bash
 
@@ -95,10 +93,9 @@ ocm --help
 
 ### Install from AUR (Arch Linux User Repository)
 
-git-url: https://aur.archlinux.org/ocm-cli.git
 package-url: https://aur.archlinux.org/packages/ocm-cli
 
-```
+```sh
 # if not using a helper util
 git clone https://aur.archlinux.org/ocm-cli.git
 cd ocm-cli
@@ -140,9 +137,9 @@ podman build -t ocm --build-arg GO_VERSION=1.22 --build-arg ALPINE_VERSION=3.19
 
 ## Examples
 
-An example of how to use the `ocm` CLI in a Makefile can be found in [`examples/make`](https://ocm.software/ocm/blob/main/examples/make/Makefile).
+An example of how to use the `ocm` CLI in a Makefile can be found in [`examples/make`](examples/make/Makefile).
 
-More comprehensive examples can be taken from the [`components`](https://ocm.software/ocm/tree/main/components) contained in this repository. [Here](components/helmdemo/README.md) a complete component build including a multi-arch image is done and finally packaged into a CTF archive which can be tranported into an OCI repository. See the readme files for details.
+More comprehensive examples can be taken from the [`components`](components) contained in this repository. [Here](components/helmdemo/README.md) a complete component build including a multi-arch image is done and finally packaged into a CTF archive which can be transported into an OCI repository. See the readme files for details.
 
 ## Contributing
 
@@ -154,4 +151,4 @@ OCM follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/m
 
 Copyright 2024 SAP SE or an SAP affiliate company and Open Component Model contributors.
 Please see our [LICENSE](LICENSE) for copyright and license information.
-Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/ocm.software/ocm).
+Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-component-model/ocm).