Repository navigation
Conversation
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>
Contributor
|
Documentation preview for this pull request is available at: |
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
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Improvement
Description
Rework of the User's Guide chapter Contribute own module (
docs/users_guide/building_simple_application).The
scrampledemo is outdated (the referenced tagv0.1.2-simple-appno longer exists, the tutorial codeonly 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: otterdognewDependableElementRepo, layout of the currentmodule_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 ownconf.pyneeded), targetsdocs,docs_check,docs_link_check,live_preview,ide_support, linking tests to requirements viaadd_test_propertiesbuilding_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 commandscicd_workflows.rst: template workflows, build/test workflow with reusablecicd-workflows(
tests.yml,qnx-build.yml), reference integration workflows incl. thepitsuitereference_integration.rst:known_good.json(version,pin_version), layers image /deploy/showcases,deploying the service, adding the showcase, platform integration test, current
score_startermenuwhats_next/index.rst: scrample hint replacedrepository_layout.pngandinitial_module_rst_content.pngImportant
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*andplatform_integration_tests/platform_infoon
mainof reference_integration, which only exist after these PRs are merged.Local checks:
bazel run //:docsbuilds without new warnings,bazel test //:format.checkpasses.Related ticket
No ticket yet.