Skip to content

Commit d593d7a

Browse files
morrison-sapmorrison-sap
committed
update templates and add template for concepts
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
2 parents ac9be7d + a8b5449 commit d593d7a

File tree

58 files changed

+4447
-2045
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+4447
-2045
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- markdownlint-disable MD041 -->
2+
#### What this PR does / why we need it
3+
4+
#### Which issue(s) this PR is related to
5+
<!--
6+
Usage: `Related to #<issue number>`, or `Related to (paste link of issue)`.
7+
-->
8+
9+
#### Type of content
10+
<!--
11+
Which section does this PR target? See CONTRIBUTING.md for guidance.
12+
-->
13+
- [ ] Tutorial (`getting-started/` or `tutorials/`)
14+
- [ ] How-to Guide (`how-to/`)
15+
- [ ] Explanation / Concept (`concepts/`)
16+
- [ ] Reference (`reference/`)
17+
- [ ] Other (infrastructure, config, fixes)
18+
19+
#### Checklist
20+
21+
- [ ] I have read and followed the [Contributing Guide](https://github.com/open-component-model/ocm-website/blob/main/CONTRIBUTING.md)
22+
- [ ] All commands/code snippets are tested and can be copy-pasted

‎.github/config/wordlist.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@ mvnrepository
245245
namespace
246246
namespaces
247247
neonephos
248+
nerdctl
248249
newcomponentaccess
249250
newcomponentversionaccess
250251
newrepository
@@ -458,3 +459,11 @@ diataxis
458459
callouts
459460
shortcode
460461
shortcodes
462+
wsl
463+
auditable
464+
hasmermaid
465+
XDG
466+
subpaths
467+
IAM
468+
pullable
469+
descriptor's

‎.github/scripts/cutoff-version.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* - Copies folder content/ to content_versioned/version-X.Y.Z
1111
* - Appends [versions."X.Y.Z"] to hugo.toml
1212
* - Appends mount/import blocks to module.toml
13+
* (version mount excludes blog/** because blog is mounted globally)
1314
* - Optional --keepDefault keeps defaultContentVersion unchanged. Required until first OCM v2 release.
1415
*/
1516

@@ -139,6 +140,7 @@ async function updateModuleToml(version) {
139140

140141
parsed.mounts = parsed.mounts || [];
141142
parsed.mounts.push({
143+
files: ['**', '!blog/**'],
142144
source: `content_versioned/version-${version}`,
143145
target: 'content',
144146
sites: { matrix: { versions: [version] } }

‎.github/workflows/publish-site.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ jobs:
4444
hugo-version: '0.155.0'
4545
extended: true
4646

47+
- name: Install Dart Sass
48+
run: sudo snap install dart-sass
49+
4750
- name: Install deps and Build
4851
run: |
4952
npm ci

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.DS_Store
22
.clinerules
3+
.clineignore
34
.hugo_build.lock
45
.idea/
56
.project

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,17 +218,19 @@ Conceptual explanation of OCM?
218218
When content applies to a specific version or repository, add a callout:
219219

220220
```markdown
221-
{{<callout context="note">}}
221+
{{<callout context="note" title="" icon="">}}
222222
This guide applies to OCM CLI v0.x. See [link] for the new library.
223223
{{</callout>}}
224224
```
225225

226226
```markdown
227-
{{<callout context="note">}}
227+
{{<callout context="note" title="" icon="">}}
228228
This feature requires the new OCM library from `open-component-model/open-component-model`.
229229
{{</callout>}}
230230
```
231231

232+
You can find appropriate icons on this [website](https://tabler.io/icons).
233+
232234
---
233235

234236
## Writing Checklists

‎assets/scss/common/_components.scss‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,10 @@
108108
margin-top: 1.75rem; /* align with TOC baseline on docs pages */
109109
}
110110
}
111+
112+
/* --------------------------------------------
113+
Details/Summary Elements (expandable sections)
114+
-------------------------------------------- */
115+
.docs-content details summary {
116+
font-size: 0.95rem; /* Kleinerer Text als normaler Absatz */
117+
}

‎assets/scss/common/_custom.scss‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@
1313
@import "pages"; // Page-specific overrides
1414
@import "version-warning"; // Version warning banner
1515
@import "landing-ord"; // Landing page & footer
16+
17+
// Note: Dart Sass compatibility fixes for the theme's search form @extend
18+
// rules are applied via assets/scss/components/_forms.scss (overrides
19+
// @thulite/doks-core's original) and defined in _forms-dart-sass-compat.scss.
20+

‎assets/scss/common/_forms-dart-sass-compat.scss‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// -----------------------------------------------------------------------------
2+
// Dart Sass compatibility fixes for @thulite/doks-core search form styles
3+
//
4+
// Context:
5+
// When migrating from libsass to dartsass (required since Hugo v0.153.0
6+
// deprecated libsass), Dart Sass is stricter about `@extend` rules: it
7+
// errors when the target selector does not exist in the current compilation.
8+
//
9+
// Problem:
10+
// @thulite/doks-core/assets/scss/components/_forms.scss uses `@extend`
11+
// without `!optional` on Bootstrap 4 utility classes (.form-group,
12+
// .form-inline) that were removed in Bootstrap 5. LibSass silently ignored
13+
// missing targets; Dart Sass throws a hard error:
14+
// "The target selector was not found. Use @extend <selector> !optional
15+
// to avoid this error."
16+
//
17+
// Fix:
18+
// We redeclare all affected rules here with `!optional`, so Dart Sass
19+
// skips the extend silently if the target selector is absent.
20+
// This file is imported via _custom.scss and takes precedence over the
21+
// theme's _forms.scss through Hugo's asset mount order (own assets/ last).
22+
//
23+
// Reference:
24+
// https://sass-lang.com/documentation/at-rules/extend/#optional-extends
25+
// https://gohugo.io/functions/css/sass/#dart-sass
26+
// -----------------------------------------------------------------------------
27+
28+
/** Search form */
29+
.search-form {
30+
@extend .form-inline !optional;
31+
}
32+
33+
.search-form label {
34+
@extend .form-group !optional;
35+
36+
font-weight: normal;
37+
}
38+
39+
.search-form .search-field {
40+
@extend .form-control !optional;
41+
}
42+
43+
.search-form .search-submit {
44+
@extend .btn !optional;
45+
@extend .btn-secondary !optional;
46+
}
47+

‎assets/scss/components/_forms.scss‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// -----------------------------------------------------------------------------
2+
// Override of @thulite/doks-core/assets/scss/components/_forms.scss
3+
/* */
4+
// This file overrides the theme original via Hugo's asset mount order
5+
// (own assets/ is mounted last and takes precedence).
6+
/* */
7+
// Reason: the original uses `@extend` without `!optional` on Bootstrap 4
8+
// classes (.form-group, .form-inline) that were removed in Bootstrap 5.
9+
// LibSass silently ignored missing targets; Dart Sass (required since Hugo
10+
// v0.153.0) throws a hard error. All rules are redeclared here with
11+
// `!optional` as the fix.
12+
/* */
13+
// See: https://sass-lang.com/documentation/at-rules/extend/#optional-extends
14+
// -----------------------------------------------------------------------------
15+
16+
// The actual fix lives in common/_forms-dart-sass-compat.scss and is also
17+
// imported from common/_custom.scss for clarity. We forward it here so the
18+
// import path components/forms (used by the theme's app.scss) still resolves.
19+
@import "../common/forms-dart-sass-compat";
20+

0 commit comments

Comments
 (0)