Skip to content

concepts: add detailed component overview and description#1027

Open
jklare wants to merge 1 commit into
mainfrom
jk-concepts-overview
Open

concepts: add detailed component overview and description#1027
jklare wants to merge 1 commit into
mainfrom
jk-concepts-overview

Conversation

@jklare

@jklare jklare commented Jul 14, 2026

Copy link
Copy Markdown
Contributor
  • replace very high level old style diagram with more detailed components overview and description
  • while working on the file, change some line breaks

* replace very high level old style diagram with more detailed
  components overview and description
* while working on the file, change some line breaks

Signed-off-by: Jan Klare <klare@osism.tech>
@github-actions

Copy link
Copy Markdown

⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 5 0 0 0.03s
✅ JSON jsonlint 4 0 0 0.1s
✅ JSON prettier 4 0 0 0.36s
✅ JSON v8r 4 0 0 8.79s
✅ MARKDOWN markdownlint 156 0 0 2.74s
✅ MARKDOWN markdown-table-formatter 156 0 0 0.37s
✅ REPOSITORY betterleaks yes no no 0.6s
✅ REPOSITORY checkov yes no no 18.39s
✅ REPOSITORY git_diff yes no no 0.07s
✅ REPOSITORY secretlint yes no no 1.79s
✅ REPOSITORY trufflehog yes no no 3.71s
✅ SPELL codespell 166 0 0 0.58s
⚠️ SPELL lychee 166 3 0 20.71s
✅ YAML prettier 6 0 0 0.32s
✅ YAML v8r 6 0 0 5.4s
✅ YAML yamllint 6 0 0 0.53s

Detailed Issues

⚠️ SPELL / lychee - 3 errors
📝 Summary
---------------------
🔍 Total..........879
🔗 Unique.........719
✅ Successful.....813
⏳ Timeouts.........2
🔀 Redirected......48
👻 Excluded........61
❓ Unknown..........0
🚫 Errors...........3
⛔ Unsupported......3

Errors in docs/guides/configuration-guide/openstack/index.md
[404] https://github.com/openstack/kolla/blob/master/docker/base/set_configs.py (at 370:30) | Rejected status code: 404 Not Found
[404] https://github.com/openstack/kolla/blob/master/docker/base/start.sh (at 369:37) | Rejected status code: 404 Not Found

Errors in docs/guides/developer-guide/style-guide.md
[TIMEOUT] https://wiki.openstack.org/wiki/GitCommitMessages (at 79:1) | Request timed out

Errors in docs/release-notes/index.md
[ERROR] https://release.osism.tech/ (at 11:1) | Connection failed. Check network connectivity and firewall settings

Errors in docs/release-notes/osism-10.md
[TIMEOUT] https://gateway-api.sigs.k8s.io/ (at 603:3) | Request timed out

Hint: Followed 48 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.6.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,JSON_JSONLINT,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_BETTERLEAKS,REPOSITORY_SECRETLINT,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,SPELL_CODESPELL,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@jklare jklare moved this from New to In review in Human Board Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

2 participants