-
Notifications
You must be signed in to change notification settings - Fork 0
move from simple GH Pages to DocuSaurus #121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
73 commits
Select commit
Hold shift + click to select a range
8d086da
adding website with docusaurus
blindzero 720a728
reset website + enhance project .gitignore
blindzero 3c10c27
first draft website + .gitignore enhancement on node etc.
blindzero 0b7f41d
update website README
blindzero 6158962
removing links in footer
blindzero 399fe76
detailing cached changes
blindzero a2c0624
fixing escapes for MDX compiling
blindzero aa44931
remove links completely from footer
blindzero 0d7b319
docs: adding capabilities reference file
ntt-matthias-fleschuetz dd5e80e
docs: added provider-capabilities about md
ntt-matthias-fleschuetz 8633284
docs: splitting plan-export about and reference
ntt-matthias-fleschuetz 753463e
temp move to docs_legacy
ntt-matthias-fleschuetz 28cfca2
docs: adding chapter intro.md files
ntt-matthias-fleschuetz a21b316
docs: configure sidebar to new structure
ntt-matthias-fleschuetz 28143a6
docs: adjust logo to new path and navbar to new structure
ntt-matthias-fleschuetz 3a5903b
docs: add sentence on intro of extend IdLE
ntt-matthias-fleschuetz 59fc863
docs: updated about intro
ntt-matthias-fleschuetz b17ff80
docs: update docs index.md
ntt-matthias-fleschuetz 9aa03c9
docs: sorted all MDs to new structure
ntt-matthias-fleschuetz 4a2376e
docs: dissolve to-sort temp folder
ntt-matthias-fleschuetz e844b46
docs: add all pages to sidebars.js
ntt-matthias-fleschuetz 5809e67
add docs-audit-result to .gitignore
ntt-matthias-fleschuetz 794c532
rename DocsAudit.ps1 to match Verb-Noun schema
ntt-matthias-fleschuetz 5c36cbe
fixed relative links in docs
ntt-matthias-fleschuetz 4912fc5
apply editorconfig settings to Test-DocsConsistency.ps1
ntt-matthias-fleschuetz 1b80a5c
make docs generator MDX safe (escaping)
ntt-matthias-fleschuetz e94d1c3
docs: updated, MDX safe generated references
ntt-matthias-fleschuetz 8e23449
put Test-DocsConsistency result file to artifacts
ntt-matthias-fleschuetz 7187769
docs: MDX compat corrections
ntt-matthias-fleschuetz 0a82e60
Test-DocsConsistency CI safe and using docusaurus excludes for orphan…
ntt-matthias-fleschuetz 391ce16
adding index.md and develop to exclude for docusaurus
ntt-matthias-fleschuetz fa69043
improve docusaurus exclude check to work with ** wildcards
ntt-matthias-fleschuetz b69392b
fix MDX compat issues with escaping
ntt-matthias-fleschuetz 6a0d4fa
include test-docsconsistency into testing.md
ntt-matthias-fleschuetz f375b5c
prettyfy output
ntt-matthias-fleschuetz b94cc64
adding idle features to homepage
ntt-matthias-fleschuetz 1acd1ae
website: sync assets
ntt-matthias-fleschuetz a871ca5
adding reference to website
ntt-matthias-fleschuetz 7ecb18e
adjust sidebar order
ntt-matthias-fleschuetz c055976
first homepage design
ntt-matthias-fleschuetz f238390
fix links and update texts of standard repo docu files
ntt-matthias-fleschuetz 0107171
rework quick start content
ntt-matthias-fleschuetz 057b8dd
fix PSSA issues
ntt-matthias-fleschuetz 936dd3b
adding gh pages deployment pipeline
ntt-matthias-fleschuetz d27c460
adding favicon.ico
ntt-matthias-fleschuetz 543421a
improved content distribution between concepts and intro
ntt-matthias-fleschuetz f47c347
added favicon path
ntt-matthias-fleschuetz 8f7a2fb
added short text intro to homepage
ntt-matthias-fleschuetz c553de0
ignore website on ci workflow
ntt-matthias-fleschuetz d9063e4
homepage styling
ntt-matthias-fleschuetz 3e7720f
sidebar item order fixed
ntt-matthias-fleschuetz cc21f0e
fixing document orders
ntt-matthias-fleschuetz 558fe82
fixing document orders
ntt-matthias-fleschuetz f489a5c
Merge branch 'website' of https://github.com/blindzero/IdentityLifecy…
ntt-matthias-fleschuetz 00835f7
Merge branch 'main' into website
ntt-matthias-fleschuetz 361528d
docs: update docs reference
ntt-matthias-fleschuetz e441683
orphanfail off for pages pipeline
ntt-matthias-fleschuetz dfb9d9f
orphanfail off for pages pipeline
ntt-matthias-fleschuetz e7314e2
Merge branch 'website' of https://github.com/blindzero/IdentityLifecy…
ntt-matthias-fleschuetz 16546e2
Merge branch 'website' of https://github.com/blindzero/IdentityLifecy…
ntt-matthias-fleschuetz 8584f61
Merge branch 'website' of https://github.com/blindzero/IdentityLifecy…
ntt-matthias-fleschuetz a977ffe
fix wrong docs redirect now to about/intro
ntt-matthias-fleschuetz 348b4da
fixed links
ntt-matthias-fleschuetz 29a94bb
fix wrong class from Svg to Img
ntt-matthias-fleschuetz 2285588
typo fix
ntt-matthias-fleschuetz 2404c3a
fix for CI compatibility for test docs
ntt-matthias-fleschuetz 9b9f330
Initial plan
Copilot 3c7dd74
Fix plan-export.md example to use correct New-IdlePlan syntax
Copilot 41fc854
only warn with BrokenLinks
ntt-matthias-fleschuetz b72181a
Merge branch 'website' into copilot/sub-pr-121-again
blindzero 75c55c8
fix broken and dead links - remove testing
ntt-matthias-fleschuetz f279ec4
Merge branch 'website' into copilot/sub-pr-121-again
blindzero ddba648
Merge pull request #123 from blindzero/copilot/sub-pr-121-again
blindzero File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| name: Website (Docs) - Build & Deploy | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - "docs/**" | ||
| - "website/**" | ||
| - "tools/**" | ||
| - ".github/workflows/pages.yml" | ||
| push: | ||
| branches: [ "main" ] | ||
| paths: | ||
| - "docs/**" | ||
| - "website/**" | ||
| - "tools/**" | ||
| - ".github/workflows/pages.yml" | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: pages-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| docs-consistency: | ||
| name: Docs consistency audit | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v6 | ||
|
|
||
| - name: Run docs consistency audit | ||
| shell: pwsh | ||
| run: > | ||
| pwsh -NoProfile -File ./tools/Test-DocsConsistency.ps1 | ||
| -DocsPath ./docs | ||
| -WebsitePath ./website | ||
| -FailOnOrphans:$false | ||
|
|
||
| - name: Upload docs audit artifact | ||
| if: always() | ||
| uses: actions/upload-artifact@v6 | ||
| with: | ||
| name: docs-audit | ||
| if-no-files-found: warn | ||
| path: | | ||
| artifacts/docs-audit.json | ||
|
|
||
| build: | ||
| name: Build Docusaurus site | ||
| runs-on: ubuntu-latest | ||
| needs: [ docs-consistency ] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v6 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
| cache: "npm" | ||
| cache-dependency-path: "website/package-lock.json" | ||
|
|
||
| - name: Install dependencies | ||
| working-directory: website | ||
| run: npm ci | ||
|
|
||
| - name: Sync docs assets | ||
| working-directory: website | ||
| run: npm run sync-assets | ||
|
|
||
| - name: Build site | ||
| working-directory: website | ||
| run: npm run build | ||
|
|
||
| - name: Upload Pages artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: website/build | ||
|
|
||
| deploy: | ||
| name: Deploy to GitHub Pages | ||
| runs-on: ubuntu-latest | ||
| needs: [ build ] | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
|
|
||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
|
|
||
| steps: | ||
| - name: Deploy | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,6 +46,7 @@ coverage.* | |
| test-results.* | ||
| *.lcov | ||
| testresults.xml | ||
| docs-audit.json | ||
|
|
||
| # Packages | ||
| *.7z | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| title: Concepts | ||
| sidebar_label: Concepts | ||
| --- | ||
|
|
||
| # IdLE Concepts | ||
|
|
||
| ## Request | ||
|
|
||
| A **LifecycleRequest** represents the business intent (for example: Joiner, Mover, Leaver). | ||
| It is the input to planning. | ||
|
|
||
| ## Plan | ||
|
|
||
| A **LifecyclePlan** is created deterministically from: | ||
|
|
||
| - request | ||
| - workflow definition | ||
| - step catalog / step registry | ||
|
|
||
| The plan is previewable and auditable. | ||
|
|
||
| ## Execute | ||
|
|
||
| Execution runs **only the plan** (no re-planning). This supports: | ||
|
|
||
| - approvals | ||
| - repeatability | ||
| - deterministic audits | ||
|
|
||
| --- | ||
|
|
||
| ## Building Blocks | ||
|
|
||
| ### Steps | ||
|
|
||
| **Steps** are reusable plugins that define convergence logic. They: | ||
|
|
||
| - Operate idempotently (converge towards desired state) | ||
| - Are provider-agnostic (use contracts, not direct system calls) | ||
| - Emit structured events for audit and progress | ||
|
|
||
| Learn more: [Steps](../use/steps.md) | [Step Catalog](../reference/steps.md) | ||
|
|
||
| ### Providers | ||
|
|
||
| **Providers** are system-specific adapters that connect workflows to external systems. They: | ||
|
|
||
| - Authenticate and manage sessions | ||
| - Translate generic operations to system APIs | ||
| - Are mockable for tests | ||
|
|
||
| Learn more: [Providers](../use/providers.md) | [Providers and Contracts](../extend/providers.md) | ||
|
|
||
| --- | ||
|
|
||
| ## Non-goals (V1) | ||
|
|
||
| IdLE.Core stays headless and avoids responsibilities that belong to a host application: | ||
|
|
||
| - no UI framework | ||
| - no interactive prompts | ||
| - no authentication flows inside steps | ||
| - no dynamic code execution from configuration | ||
|
|
||
| --- | ||
|
|
||
| ## Next Steps | ||
|
|
||
| - [Installation](../use/installation.md) — Install and import guide | ||
| - [Quickstart](../use/quickstart.md) — Run the demo | ||
| - [Architecture](../about/architecture.md) — Design principles and decisions | ||
| - [Workflows](../use/workflows.md) — Define lifecycle workflows |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.