requirements by AlexanderLanin · Pull Request #67 · eclipse-score/docs-as-code

AlexanderLanin · 2025-06-03T16:10:13Z

initial set of docs-as-code requirements

github-actions · 2025-06-03T16:11:17Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
INFO: Invocation ID: 81d9b045-16ea-40fe-9cfc-5a4e547405f3
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (103 packages loaded, 10 targets configured)

Analyzing: target //src:license-check (147 packages loaded, 1774 targets configured)

Analyzing: target //src:license-check (157 packages loaded, 2666 targets configured)

Analyzing: target //src:license-check (157 packages loaded, 2682 targets configured)

Analyzing: target //src:license-check (161 packages loaded, 4815 targets configured)

INFO: Analyzed target //src:license-check (162 packages loaded, 4941 targets configured).
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 16.144s, Critical Path: 0.45s
INFO: 13 processes: 4 disk cache hit, 9 internal.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/docs-as-code -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 83 items.
[main] INFO Found 58 items.
[main] INFO Querying ClearlyDefined for license data for 25 items.
[main] ERROR Error response from ClearlyDefined 429

github-actions · 2025-06-04T11:44:53Z

The created documentation from the pull request is available at: docu-html

Co-authored-by: Maximilian Sören Pollak <MaximilianSoerenPollak@users.noreply.github.com>

Co-authored-by: Alexander Lanin <Alexander.Lanin@bosch.com>

Added needpie to showcase implemeneted status Removed some TODOs Added notes where applicable Changed headers to be similar to the rest

Iteration on tool_reqs

Co-authored-by: Maximilian Sören Pollak <MaximilianSoerenPollak@users.noreply.github.com>

….noreply.github.com>

AlexanderLanin · 2025-06-12T20:36:51Z

@MaximilianSoerenPollak I've just tried rebasing and squashing all of this. I ended up with 0 changes. I don't see any need to clean this PR up before final review.

Copilot

Pull Request Overview

This PR introduces the initial docs-as-code requirements and landing pages by adding new product and how-to guides, updating the root and product indexes, and adjusting build and editor configurations.

Added product landing with “Features” and “Requirements” cards and updated toctree
Introduced core “Capabilities”, “How to Use”, and “How to Integrate” documentation
Updated Bazel and external-needs configuration, enabled Myst colon-fence, and added VSCode settings

Reviewed Changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
docs/product/index.rst	Updated product index grid layout and toctree entries
docs/product/extensions/metamodel.md	Removed outdated “Getting started” link
docs/product/capabilities.md	Added new capabilities document
docs/index.rst	Revised main index cards and expanded sitemap toctree
docs/how-to-use/index.rst	Added “How To Use” landing page
docs/how-to-integrate/index.rst	Added “How to Integrate” landing page
docs/how-to-integrate/getting_started.md	Updated example link and removed extensions overview
docs/how-to-integrate/example/testing/index.rst	Updated need ID in example
docs/how-to-integrate/example/index.rst	Updated need ID in example
docs/conf.py	Enabled `myst_enable_extensions = ["colon_fence"]`
docs/BUILD	Added external_needs_info and targets for `score_process`
MODULE.bazel	Added `bazel_dep` for `score_process`
.vscode/settings.json	Reformatted Bazel LSP args and disabled internal type checking

Comments suppressed due to low confidence (3)

docs/product/extensions/metamodel.md:6

The Getting Started link was removed; consider replacing it with a pointer to the new 'How to Integrate' or 'How to Use' guide so readers can find setup instructions for this extension.

See [Getting started](../getting_started) for more information on why we use extensions.

docs/how-to-use/index.rst:12

The toctree references 'faq', but no docs/how-to-use/faq.rst file exists. Please verify the filename or add the missing FAQ document.

*   faq

docs/how-to-integrate/getting_started.md:129

The 'Available Extensions' section was removed, potentially leaving users without guidance. Ensure that extension overviews are available elsewhere or link them from a central index.

## Available Extensions

MaximilianSoerenPollak · 2025-06-13T05:58:57Z

@MaximilianSoerenPollak I've just tried rebasing and squashing all of this. I ended up with 0 changes. I don't see any need to clean this PR up before final review.

I think overall the PR looks good. We have now gone over it quiet a bit.
I think anything else that we may find can be addressed in future PR's.

MaximilianSoerenPollak

Just the comments, but those can be fixed / addressed in later PR's.

Glad we can finally merge this, what a saga.

MaximilianSoerenPollak · 2025-06-13T06:03:08Z

+  - Latest documentation (e.g. `main` branch)
+- ✅ Keeps linked repositories and their rendered websites unaffected by incoming references
+- Allows bidirectional links for integration-focused documentation
+- In addition to high level versioning of repositories, supports verifying suspect links on a requirement level


Not quiet sure what suspect links are.

Random website:

A link is 'Suspect' when the Object was modified more recently than the corresponding link attribute

We should add that to our documentation/glossary

MaximilianSoerenPollak · 2025-06-13T06:03:48Z

+- ✅ Live preview functionality for documentation authors
+- ✅ Integrated linting for:
+  - Syntax and formatting (reST and Markdown)
+  - Internal and external link validity


Internal yes (through sphinx / esbonio) ?

I think that was meant to refer to external needs. And those are checked.

Co-authored-by: Maximilian Sören Pollak <maximilian.pollak@expleogroup.com> Signed-off-by: Alexander Lanin <alex@lanin.de>

MaximilianSoerenPollak

👍

Co-authored-by: Maximilian Sören Pollak <maximilian.pollak@expleogroup.com>

github-project-automation Bot added this to INF - Infrastructure Community Jun 3, 2025

github-project-automation Bot moved this to Todo in INF - Infrastructure Community Jun 3, 2025

MaximilianSoerenPollak force-pushed the requirements branch from eaf58ff to 5693a05 Compare June 4, 2025 11:40

MaximilianSoerenPollak force-pushed the requirements branch from 3224d3d to b1891b7 Compare June 4, 2025 13:07

AlexanderLanin and others added 15 commits June 11, 2025 11:20

requirements v0

fddbf32

Co-authored-by: Maximilian Sören Pollak <MaximilianSoerenPollak@users.noreply.github.com>

Rebase onto main

6a126b3

Make implemented 'optional'

5e26cb3

Fix build & rst issues

7964ac1

Formatting

93cfe01

Remove temp changes in metamodel

58976ed

Fix table rendering

1fe2fd6

Fix 'headers'

b3cc6a6

Added new requirements

3ac51d5

Adding release related reqs

6c096a4

Add metamodel new attributes

4a78394

WIP Tooling Requirements

9fca21d

Co-authored-by: Alexander Lanin <Alexander.Lanin@bosch.com>

went through all areas, should be complete now

40a8a83

Cleanup of reqs

f2ff4e0

Added needpie to showcase implemeneted status Removed some TODOs Added notes where applicable Changed headers to be similar to the rest

Fix rst header

d4e8140

MaximilianSoerenPollak force-pushed the requirements branch from c8098b7 to d4e8140 Compare June 11, 2025 09:25

MaximilianSoerenPollak and others added 8 commits June 11, 2025 11:38

Fix formatting

d5c5d9a

Adding a warning to tmp req.

c1199be

Overhaul of requirements

5a1528f

Iteration on tool_reqs

ChatGPT round 1

f42ea2e

ChatGPT round 2

d9d2dbf

new menu, no changes

bf91600

metamodel reqId

451f338

Reorganized landing page

5ecbf4f

Co-authored-by: Maximilian Sören Pollak <MaximilianSoerenPollak@users.noreply.github.com>

AlexanderLanin added 3 commits June 12, 2025 18:13

Co-authored-by: Maximilian Sören Pollak <MaximilianSoerenPollak@users…

5d2485d

….noreply.github.com>

md fix

c3fa99d

fix all warnings

3dcd783

AlexanderLanin marked this pull request as ready for review June 12, 2025 20:36

AlexanderLanin requested a review from Copilot June 12, 2025 20:37

Copilot AI reviewed Jun 12, 2025

View reviewed changes

Comment thread docs/product/index.rst

Comment thread docs/product/capabilities.md Outdated

MaximilianSoerenPollak previously approved these changes Jun 13, 2025

View reviewed changes

typo

4bb4100

Co-authored-by: Maximilian Sören Pollak <maximilian.pollak@expleogroup.com> Signed-off-by: Alexander Lanin <alex@lanin.de>

AlexanderLanin dismissed MaximilianSoerenPollak’s stale review via 4bb4100 June 13, 2025 06:14

MaximilianSoerenPollak approved these changes Jun 13, 2025

View reviewed changes

AlexanderLanin merged commit 9c7cef3 into main Jun 13, 2025
7 checks passed

AlexanderLanin deleted the requirements branch June 13, 2025 06:25

github-project-automation Bot moved this from Todo to Done in INF - Infrastructure Community Jun 13, 2025

AlexanderLanin mentioned this pull request Jun 13, 2025

Start documenting requirements towards infrastructure & tooling. eclipse-score/score#1116

Closed

arnoox pushed a commit to arnoox/score-docs-as-code that referenced this pull request Feb 20, 2026

add requirements (eclipse-score#67)

5ea6264

Co-authored-by: Maximilian Sören Pollak <maximilian.pollak@expleogroup.com>

Conversation

AlexanderLanin commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Jun 4, 2025

Uh oh!

AlexanderLanin commented Jun 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

MaximilianSoerenPollak commented Jun 13, 2025

Uh oh!

MaximilianSoerenPollak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MaximilianSoerenPollak Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MaximilianSoerenPollak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AlexanderLanin commented Jun 3, 2025 •

edited

Loading

github-actions Bot commented Jun 3, 2025 •

edited

Loading