Commit graph

114 commits

Author SHA1 Message Date
3239cfbc62 refactor(architecture): reorganize LikeC4 projects and consolidate webcomponents
Renamed resources/likec4 to resources/edp-likec4 to better reflect that this
directory contains the Enterprise Developer Platform architecture models,
not documentation platform architecture.

Extended element kinds in edp-likec4/models/spec.c4 to support documentation
platform modeling:
- Added person, tool, process, repository element kinds
- These allow modeling of documentation workflows and processes

Consolidated webcomponent generation:
- Combined both architecture projects (edp-likec4 and doc-likec4) into a
  single webcomponent output at static/js/likec4-webcomponent.js
- Updated Taskfile.yml to generate from edp-likec4 directory
- Removed duplicate webcomponent script loading in head-end.html
- Fixed CustomElementRegistry duplicate registration issue

Embedded TeleNeoOffice corporate fonts:
- Added font files to static/fonts/ and static/ root
- Required for correct rendering of diagrams in webcomponent
- Fonts are embedded in webcomponent but also served from Hugo static paths
- Fixed 404 errors for font loading

Updated architecture documentation:
- Fixed markdown linting issues (trailing spaces, fence spacing)
- Updated all references from resources/likec4 to resources/edp-likec4
- Enhanced setup.md with correct directory structure

This refactoring enables:
1. Clear separation between EDP architecture and documentation platform models
2. Single consolidated webcomponent containing all architecture views
3. Proper font loading for corporate branding in diagrams
4. Foundation for future architecture documentation expansion

Breaking changes: None (paths updated in documentation)
2025-11-07 11:50:17 +01:00
eec679657b Merge remote-tracking branch 'refs/remotes/ipceicis/development' into development 2025-10-25 09:29:19 +02:00
8785b327dd feat(docs): integrate LikeC4 interactive diagrams into Hugo/Docsy
Implement complete integration of LikeC4 interactive architecture
diagrams into the Hugo/Docsy documentation system, enabling embedded
web components for exploring C4 models directly in documentation pages.

Integration Components:

Static Assets:
- static/js/likec4-webcomponent.js (3.1 MB) - Generated web component
  containing all 54 C4 views as interactive embeddable elements
- static/js/likec4-loader.js - Dynamic ES6 module loader with fallback
  paths for robust component loading across different page depths
- static/css/likec4-styles.css - Styling for diagram containers with
  dark mode support for Docsy theme compatibility

Hugo Configuration:
- hugo.toml - Added params.likec4.enable configuration flag
- layouts/partials/hooks/head-end.html - Hook to inject CSS and JS
  when LikeC4 is enabled site-wide

Documentation:
- content/en/docs/architecture/_index.md - Architecture section index
- content/en/docs/architecture/highlevelarch.md - Example page with
  interactive OTC FaaS deployment diagram demonstrating integration
- content/en/docs/architecture/setup.md - Comprehensive setup guide
  covering installation, usage, workflow, and troubleshooting
- resources/likec4/INTEGRATION.md - Technical integration details
- LIKEC4-QUICKSTART.md - Quick start guide for developers

Features:
- Interactive diagram exploration (click components for details)
- Automatic loading indicators with timeout fallback
- Graceful degradation for non-JS environments
- Dark mode support matching Docsy theme
- Multiple diagrams per page support
- Browser compatibility detection

Usage Pattern:
```html
<div class="likec4-container">
    <div class="likec4-header">Diagram Title</div>
    <likec4-view view-id="otc-faas" browser="true"></likec4-view>
    <div class="likec4-loading">Loading...</div>
</div>
```

Workflow:
1. Edit .c4 files in resources/likec4/
2. Run: npx likec4 gen webcomponent --webcomponent-prefix likec4
   --outfile ../../static/js/likec4-webcomponent.js
3. Commit both model changes and regenerated webcomponent

Available Views:
- otc-faas, edp, landscape, edpbuilderworkflow
- keycloak, forgejo, argocd, crossplane, monitoring
- And 40+ more component and deployment views

The integration preserves the MkDocs-style embedding approach from
edp-doc while adapting it to Hugo's static site generation model.

This completes the migration making this repository the central hub
for both C4 architecture models and their rendered documentation.
2025-10-24 13:08:59 +02:00
43cbd69c9c refactor(docs): migrate existing content to v1 legacy structure
- Move all existing docs content (concepts, project, solution) to /docs/v1/
- Add legacy banner component to warn users about archived documentation
- Create v1 index page with legacy notice and redirect guidance
- Implement automatic banner display for all v1 paths
- Preserve all original content for reference during migration

This enables incremental content migration while maintaining access to
original documentation.
2025-10-23 14:54:08 +02:00
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
Bot
ceb213cf64 doc(work-structure): MVP1-12-OTC kickoff planning 2025-04-29 15:23:37 +02:00
Bot
1bbedec64a ex post: review minutes 01.04.25 2025-04-29 15:21:31 +02:00
fa1e343247 doc(arch): minutes of a robert-stephan talk about crossplane vs terraform 2025-03-31 09:58:40 +02:00
2949d154f9 chore(architecture): minutes of several meetings in the new-architecture agenda 2025-02-25 16:32:30 +01:00
908f2c1c93 doc(concepts): building blocks of platforms recommended by John Dietz, CEO of Konstruct 2025-01-23 15:44:55 +01:00
828bc484c9 chore(): adjusted frontmatter 2024-12-19 21:52:35 +01:00
Kai Reichart
4d8e1c8938 updated adr 2024-12-19 10:28:28 +01:00
Kai Reichart
92cd525ea9 added ADR for pipelines 2024-12-19 10:28:28 +01:00
311269eb39 Merge branch 'development' 2024-12-19 10:04:45 +01:00
9e6d42ffb0 Update _index.md
more details for dashboards, nginx
2024-12-13 15:02:20 +01:00
7ab69e9139 fix(): typo 2024-12-11 15:05:15 +01:00
8599ddbefc Telemetry Use Case
added Telemetry Use Case showing Fibonacci workload
2024-12-05 14:27:02 +01:00
662d26581c feat(architecture): WiP ... just a notice on the outcome of today's arch session 2024-12-04 14:48:53 +01:00
58da741bca doc(architecture): added architectural decision of templated stacks 2024-12-04 14:36:59 +01:00
1b77a80563 Merge remote-tracking branch 'refs/remotes/ipceicis-dev/main' 2024-11-29 09:00:58 +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
a8bf2ae252 fix(pos-structure): addid cahrts, refactored 2024-11-27 11:13:36 +01:00
6b37c0b08a feat(poc-structure): added high level design of poc output 2024-11-26 16:50:01 +01:00
9ec0ae1ca9 Merge branch 'development' into feature/IPCEICIS-724-work-out-concept-for-repository-process-and-structure-especially-poc 2024-11-26 16:36:16 +01:00
b377a35439 doc(stakeholder-workshop): finalized documentation 2024-11-25 15:41:23 +01:00
4ca5829b90 Merge branch 'development' into stakeholder-workshop 2024-11-25 14:44:29 +01:00
741563c236 feat(team-process): IPCEICIS-724, WiP, to be discussed in arch session 2024-11-19 13:24:17 +01:00
73b4a5030c fix() 2024-11-19 09:51:32 +01:00
bd4672c103 WiP 2024-11-18 22:37:37 +01:00
206f67d33c WiP check if confluence gets this included 2024-11-18 16:04:48 +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
kai.reichart
805bb5de09 Merge branch 'main' into feature/cicd-concept 2024-11-11 12:46:57 +00: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
340b5d02e0 Merge pull request 'docs(routing): more general information on http-routing' (#13) from routing-excerpt into main
Reviewed-on: https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/website-and-documentation/pulls/13
2024-11-08 12:30:31 +00:00
e6a44cdc80 doc(stakeholder-workeshop) 2024-11-07 12:47:08 +01:00
64c020de47 WiP statkeholder workshop 2024-11-07 09:37:33 +01: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
afaf0f8049 doc(solution): added design documentation structure and first proposal for agnostic EDF deployments 2024-10-17 11:12:16 +00:00
08847aac0a fix() 2024-10-17 07:46:36 +00:00
Stefan Bethke
340f6400c4 IPCEICIS-437 add Velero docs 2024-10-15 07:37:04 +00: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
529fa5423a Merge branch 'main' into development 2024-10-11 11:51:19 +02:00
952d170d83 refactor(solution): section 'solution' refactored into a dedicated 'CNOE' subsection 2024-10-11 09:34:06 +00:00