Skip to content

docs: base users guide example on the platform info service - #3445

Draft
antonkri wants to merge 3 commits into
mainfrom
docs/users-guide-platform-info-example
Draft

antonkri wants to merge 3 commits into
mainfrom
docs/users-guide-platform-info-example

Conversation

@antonkri

@antonkri antonkri commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Improvement

Description

Rework of the User's Guide chapter Contribute own module (docs/users_guide/building_simple_application).
The scrample demo is outdated (the referenced tag v0.1.2-simple-app no longer exists, the tutorial code
only lives on an unmerged branch) and the repository is going to be archived. The chapter now uses the
platform info service and its client, the platform info consumer, from
eclipse-score/reference_integration#446 as running example. The structure of the chapter is unchanged.

  • first_score_module.rst: otterdog newDependableElementRepo, layout of the current module_template
    (table instead of outdated screenshot), .bazelrc / score_toolchain.bazelrc, minimal module declaration,
    current dependencies, docs(project=..., project_url=...)
  • doc_generation.rst: docs() parameters (no own conf.py needed), targets docs, docs_check,
    docs_link_check, live_preview, ide_support, linking tests to requirements via add_test_properties
  • building_source_code.rst: mw::com interface (skeleton/proxy), service and consumer, mw_com_config.json,
    Bazel targets incl. genrule from known_good.json, toolchains/configurations, build and run commands
  • cicd_workflows.rst: template workflows, build/test workflow with reusable cicd-workflows
    (tests.yml, qnx-build.yml), reference integration workflows incl. the pit suite
  • reference_integration.rst: known_good.json (version, pin_version), layers image / deploy / showcases,
    deploying the service, adding the showcase, platform integration test, current score_starter menu
  • whats_next/index.rst: scrample hint replaced
  • removed the outdated screenshots repository_layout.png and initial_module_rst_content.png

Important

Draft until eclipse-score/reference_integration#446 (stacked on #401 and #445) is merged: the new links point to
deploy/platform_info, showcases/standalone/platform_info* and platform_integration_tests/platform_info
on main of reference_integration, which only exist after these PRs are merged.

Local checks: bazel run //:docs builds without new warnings, bazel test //:format.check passes.

Related ticket

No ticket yet.

Replace the scrample walkthrough with the platform info service and its consumer from reference_integration (PR #446) and update module template, docs-as-code, toolchain, CI/CD and reference integration details to the current state.

Signed-off-by: Anton Krivoborodov <anton.krivoborodov@bmw.de>
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-3445: https://eclipse-score.github.io/score/pr-3445/

Signed-off-by: Anton Krivoborodov <anton.krivoborodov@bmw.de>
…ollection

Signed-off-by: Anton Krivoborodov <anton.krivoborodov@bmw.de>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog
Status: No status

Development

Successfully merging this pull request may close these issues.

1 participant