|
|
f797af114b
|
test: configure comprehensive markdown linting with Docsy best practices
Configure markdownlint with rules aligned to technical documentation
standards and Docsy theme conventions.
Design Decisions:
- Enable core quality rules (heading hierarchy, consistent list styles)
- Allow inline HTML for Docsy shortcodes and components
- Permit bare URLs (common in technical documentation)
- Make code block language hints optional (pragmatic for existing content)
- Set maximum 2 consecutive blank lines (balanced readability)
- Enforce single trailing newline (POSIX standard)
- Use asterisk for unordered lists (consistency)
- Allow 2-space list indentation (Markdown standard)
Auto-fixed Issues:
- Converted dash lists to asterisk lists (568 fixes)
- Removed trailing spaces (211 fixes)
- Added missing trailing newlines (74 fixes)
- Added blank lines around lists and headings (100+ fixes)
Remaining Style Warnings (intentionally accepted):
- MD029: List numbering variations in meeting notes (75 instances)
- MD036: Bold text for section headers in ADRs (13 instances)
- MD025: Multiple H1 in notes/brainstorming docs (10 instances)
- MD032/MD022: Minor spacing variations (15 instances)
Test Results:
✅ Hugo build: 227 pages generated successfully
✅ HTML validation: No errors
✅ Link checking: All links valid (except dev-only livereload)
✅ Markdown linting: Only non-critical style warnings remain
The configuration balances strict quality checks with pragmatic
flexibility for diverse content types (documentation, ADRs, meeting
notes, tutorials).
|
2025-10-23 14:25:46 +02:00 |
|
|
|
9e6d42ffb0
|
Update _index.md
more details for dashboards, nginx
|
2024-12-13 15:02:20 +01:00 |
|
|
|
e0dce8ef46
|
deploy kube-prometheus (2)
|
2024-11-28 15:23:40 +01:00 |
|
|
|
0b7a85575e
|
deploy kube-prometheus
|
2024-11-28 15:18:10 +01:00 |
|
|
|
b545fff0be
|
Added documentation for how to publish provider-kind in a custom docker registry
|
2024-11-14 14:59:56 +01:00 |
|
|
|
04954fcb04
|
Added documentation for crossplane provider-kind
|
2024-11-13 09:05:04 +01:00 |
|
|
|
923c2f87c0
|
refactor(included-backstage-templates): chapter moved to CNOE as it's not idpbuilder related
|
2024-11-08 14:02:39 +01:00 |
|
|
|
a68629559d
|
Merge branch 'development' into idpbuilder-backstage-templates
|
2024-11-08 13:55:44 +01:00 |
|
|
|
3f2bbdaf48
|
Merge pull request 'feat(cnoe-argocd): Overview of argocd and general description of its role in CNOE' (#14) from cnoe-argocd into main
Reviewed-on: https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/website-and-documentation/pulls/14
|
2024-11-08 12:36:27 +00:00 |
|
|
|
cd03301ee8
|
Added articles about backstage templates included into idpbuilder ref-implementation
|
2024-10-29 08:01:53 +01:00 |
|
|
|
c3d3fbc08d
|
feat(cnoe-argocd): Overview of argocd and general description of its role in CNOE
Refs: #IPCEICIS-465
|
2024-10-24 14:43:44 +02:00 |
|
|
|
faae6cb62a
|
docs(routing): more general information on http-routing
|
2024-10-21 10:00:20 +02:00 |
|
|
|
a5a7c84b6e
|
refactor(tools): kyverno moved to tools
|
2024-10-11 10:01:40 +00:00 |
|
|
|
b41676b668
|
Merge branch 'development' into http-routing
|
2024-10-11 11:57:45 +02:00 |
|
|
|
952d170d83
|
refactor(solution): section 'solution' refactored into a dedicated 'CNOE' subsection
|
2024-10-11 09:34:06 +00:00 |
|
|
|
ac17c07503
|
feat(http-routing): added docs describing routing of http traffic in the platform
Refs: #IPCEICIS-468
|
2024-10-10 20:25:58 +02:00 |
|
|
|
a8dcf6304c
|
feat(cnoe-verification): added description of the findings researching the validation and verification capabilities in the CNOE framework
Refs: #IPCEICIS-467
|
2024-10-10 18:35:31 +02:00 |
|
|
|
2280f8b740
|
Added article about kyverno integration for idpbuilder
|
2024-10-10 08:39:28 +02:00 |
|
|
|
275a236fa9
|
Added article about kyverno integration for idpbuilder
|
2024-10-10 08:37:06 +02:00 |
|
|
|
a4ec27e18d
|
Added article about kyverno integration for idpbuilder
|
2024-10-10 08:35:49 +02:00 |
|
|
|
f6149c748d
|
Added article about Backstage setup and plugin creation
|
2024-10-04 08:51:09 +02:00 |
|
|
|
573e7b0f95
|
Added article about Backstage setup and plugin creation
|
2024-10-04 08:50:50 +02:00 |
|
|
|
9452f29c3f
|
Merge branch 'development' into feature/ipceicis-460-cnoe-deep-dive
|
2024-10-01 13:29:36 +02:00 |
|
|
|
ea43b75911
|
Update content/en/docs/solution/tools/idpbuilder/installation/_index.md
Fixed a bug and added next steps
|
2024-09-30 13:57:11 +00:00 |
|
|
|
c903a6c4e8
|
doc(ipceicis-460): added cnoe github project analysis outcome
|
2024-09-30 00:33:55 +02:00 |
|
|
|
4ed21ee54d
|
refactor(ipceicis-460-cnoe-deep-dive): top level documenation hierarchy refoctored to three entries concepts, solurion, project
|
2024-09-29 12:20:35 +02:00 |
|
