Skip to content

Commit c704b43

Browse files
mmitorajmmitoraj
authored
Merge pull request #546 from mmitoraj/config
Add link checker, CODEOWNERS, and templates
2 parents 73ea6b0 + 43d2845 commit c704b43

8 files changed

Lines changed: 155 additions & 7 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Report a bug in the project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Thank you for your contribution. Before you submit the issue:
11+
1. Search open and closed issues for duplicates.
12+
2. Read the contributing guidelines.
13+
-->
14+
15+
**Description**
16+
17+
<!-- Provide a clear and concise description of the problem.
18+
Describe where it appears, when it occurred, and what it affects. -->
19+
20+
<!-- Provide relevant technical details such as the cluster name and address (URL), browser name and version, or the operating system. -->
21+
22+
**Expected result**
23+
24+
<!-- Describe what you expect to happen. -->
25+
26+
**Actual result**
27+
28+
<!-- Describe what happens instead. -->
29+
30+
**Steps to reproduce**
31+
32+
<!-- List the steps to follow to reproduce the bug. Attach any files, links, code samples, or screenshots that could help in investigating the problem. -->
33+
34+
**Troubleshooting**
35+
36+
<!-- Describe the steps you have already taken to solve the issue. -->

‎.github/ISSUE_TEMPLATE/documentation-improvement.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest an improvement or report a bug in the documentation
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Thank you for your contribution. Before you submit the issue:
11+
1. Search open and closed issues for duplicates.
12+
2. Read the contributing guidelines.
13+
3. Assign the Documentation project.
14+
-->
15+
16+
**Description**
17+
18+
<!-- Provide a clear and concise description of the potential documentation improvement.-->
19+
20+
**Area**
21+
22+
<!-- Provide the area the document refers to. For example, write:
23+
* Management Plane Services
24+
* Application integration
25+
* Runtime provisioning -->
26+
27+
**Reasons**
28+
29+
<!-- Explain why we should improve the document. -->
30+
31+
**Assignees**
32+
33+
@kyma/technical-writers
34+
35+
**Attachments**
36+
37+
<!-- Attach any files, links, code samples, or screenshots that will convince us to your idea. -->

‎.github/ISSUE_TEMPLATE/sample-request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Sample request
3+
about: Suggest a sample idea for SAP BTP, Kyma runtime
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Thank you for your contribution. Before you submit the issue:
11+
1. Search open and closed issues for duplicates.
12+
2. Read the contributing guidelines.
13+
-->
14+
15+
**Description**
16+
17+
<!-- Provide a clear and concise description of the expected sample. -->
18+
19+
**Reasons**
20+
21+
<!-- Explain why we should add this sample. Provide use cases to illustrate its benefits. -->
22+
23+
**Attachments**
24+
25+
<!-- Attach any files, links, code samples, or screenshots that will convince us to your idea. -->

‎.github/pull-request-template.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!-- Thank you for your contribution. Before you submit the pull request:
2+
1. Follow contributing guidelines, templates, the recommended Git workflow, and any related documentation.
3+
2. Read and submit the required Contributor Licence Agreements (https://github.com/kyma-project/community/blob/main/CONTRIBUTING.md#agreements-and-licenses).
4+
3. Test your changes and attach their results to the pull request.
5+
4. Update the relevant documentation.
6+
-->
7+
8+
**Description**
9+
10+
Changes proposed in this pull request:
11+
12+
- ...
13+
- ...
14+
- ...
15+
16+
**Related issue(s)**
17+
<!-- If you refer to a particular issue, provide its number. For example, `Resolves #123`, `Fixes #43`, or `See also #33`. -->

‎.github/workflows/markdown-links.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: PR Docu Checks
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- "main"
7+
paths-ignore:
8+
- 'dependencies/**'
9+
- 'OWNERS'
10+
- 'CODEOWNERS'
11+
- 'external-images.yaml'
12+
workflow_dispatch:
13+
14+
jobs:
15+
markdown-link-check:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repo
19+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
20+
- name: Install node.js
21+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
22+
with:
23+
node-version: "22.x"
24+
- name: Install md-check-link
25+
run: npm install -g md-check-link
26+
- name: Verify links
27+
run: |
28+
md-check-link -q -n 8 -c https://raw.githubusercontent.com/kyma-project/md-check-link/main/.mlc.config.json ./

‎CODEOWNERS‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Default owners of the repository
2+
* @abbi-gaurav @mmitoraj
3+
4+
# All .md files
5+
*.md @mmitoraj @NHingerl @IwonaLanger @nataliasitko @grego952

‎from-zero-to-cap-on-kyma/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ make init
6060

6161
Let's take a minute to inspect our cap application. It is a simple Bookshop sample where you can access Book entries via API calls.
6262
63-
- Data model defined in [./bookshop/db/data-model.cds](./bookshop/db/data-model.cds)
64-
- Core Data Service defined in [./bookshop/srv/cat-service.cds](./bookshop/srv/cat-service.cds)
63+
- Data model defined in [./bookshop/db/data-model.cds](./bookshop/db/data-model.cds) <!-- markdown-link-check-disable-line -->
64+
- Core Data Service defined in [./bookshop/srv/cat-service.cds](./bookshop/srv/cat-service.cds) <!-- markdown-link-check-disable-line -->
6565
6666
Directly from CAP website, *CAP promotes getting started with minimal upfront setup, based on convention over configuration, and a grow-as-you-go approach, adding settings and tools later on, only when you need them.*
6767
@@ -151,12 +151,12 @@ We will use [Helm Charts](https://helm.sh/) to define the required configuratio
151151
make create-helm-chart
152152
```
153153
154-
Now take a moment to understand the generated Helm chart in the [chart](./bookshop/chart) directory.
154+
Now take a moment to understand the generated Helm chart in the [chart](./bookshop/chart) directory. <!-- markdown-link-check-disable-line -->
155155
156156
![helm-chart](assets/helm-chart.png)
157157
158-
- [bookshop/chart/Chart.yaml](bookshop/chart/Chart.yaml) contains the details about the chart and all its dependencies.
159-
- [bookshop/chart/values.yaml](bookshop/chart/values.yaml) contains all the details to configure the chart deployment. You will notice that it has sections for `hana deployer`, `cap application` as well as required `service instances` and `service bindings`
158+
- [bookshop/chart/Chart.yaml](bookshop/chart/Chart.yaml) contains the details about the chart and all its dependencies. <!-- markdown-link-check-disable-line -->
159+
- [bookshop/chart/values.yaml](bookshop/chart/values.yaml) contains all the details to configure the chart deployment. You will notice that it has sections for `hana deployer`, `cap application` as well as required `service instances` and `service bindings` <!-- markdown-link-check-disable-line -->
160160
161161
### Deploy helm chart
162162

‎kyma-access-auth0-as-idp/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ In the following example, I am using the default role `cluster-admin`. If you wa
111111

112112
### Configure IAS for RBAC
113113

114-
The groups configured in Auth0 are manifest as a string array for assertion attribute `http://schemas.xmlsoap.org/claims/Group`. Because the Kyma OIDC is configured to expect the `groupsClaim` attribute as `groups`, you must enrich the assertion attribute that is received from Auth0.
114+
The groups configured in Auth0 are manifest as a string array for assertion attribute `http://schemas.xmlsoap.org/claims/Group`. Because the Kyma OIDC is configured to expect the `groupsClaim` attribute as `groups`, you must enrich the assertion attribute that is received from Auth0. <!-- markdown-link-check-disable-line -->
115115

116116
>Note: You can also use the attribute received from Auth0 and configure the same in Kyma. Using `groups` makes it clearer.
117117
118118
1. For the Auth0 configured corporate identity provider, add an entry for `Enriched Assertion Attributes`
119119
- `Attribute`: groups
120-
- `Value`: ${http://schemas.xmlsoap.org/claims/Group}
120+
- `Value`: ${http://schemas.xmlsoap.org/claims/Group} <!-- markdown-link-check-disable-line -->
121121
![ias-enrich-attribute](assets/ias-enrich-attribute.png)
122122
2. In your application in IAS, verify the following:
123123
- `groups` is an assertion attribute.

0 commit comments

Comments
 (0)