Skip to content

restructuring+contrib+intro - #3224

Open
anmittag wants to merge 4 commits into
eclipse-score:mainfrom
etas-contrib:restruct_contrib_intro_added
Open

restructuring+contrib+intro#3224
anmittag wants to merge 4 commits into
eclipse-score:mainfrom
etas-contrib:restruct_contrib_intro_added

Conversation

@anmittag

@anmittag anmittag commented Aug 26, 2026

Copy link
Copy Markdown
Member
  • complete restructuring an adaptation of score repo according to folder structure
  • Added Introduction and Contribution Guide to cover all the first getting started infos
  • Basically no new and no deleted information, mostly shifted from a to b and renaming
  • added document-needs and references

@github-actions

Copy link
Copy Markdown
Contributor

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

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anmittag

anmittag commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

@masc2023 :

User`Guide: Yes, Moved to contributor Guide. User = Using the middleware Contributor = Providing Code, Test, etc to the middleware

What rules to follow: needs from wp__sw_development_plan

Training: needs from wp__training_path

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@masc2023

Copy link
Copy Markdown
Contributor

@masc2023 :

User`Guide: Yes, Moved to contributor Guide. User = Using the middleware Contributor = Providing Code, Test, etc to the middleware

What rules to follow: needs from wp__sw_development_plan

Training: needs from wp__training_path

Ok, then may we need to revise some realizes later, seems not correct.

masc2023
masc2023 previously approved these changes Aug 26, 2026

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rework of realizes needed after merge

@anmittag

Copy link
Copy Markdown
Member Author

Then it was good to summarize 😎

Comment thread docs/contribute/development/python/python_coding_guidelines.rst
Comment thread docs/contribute/general/folder_structure_convention.rst Outdated
@anmittag
anmittag dismissed stale reviews from RolandJentschETAS and masc2023 via ab2e48b August 27, 2026 05:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

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

Suppressed comments (7)

docs/quality/qms_report.rst:354

  • The renamed review report defines doc__safety_plan_fdr_platform, not doc__platform_safety_plan_fdr; this link and status copy will fail.
    docs/contribute/general/folder_structure_convention.rst:35
  • This is malformed reStructuredText: the URL is missing link text, a closing >, and the trailing link marker, so the repository reference will render as broken text.
    docs/introduction/useful_links.rst:58
  • This URL points to a nonexistent contribution_attribution_guideline_guideline.html page. The relocated source renders as contribution_attribution_guide.html.
    docs/contribute/contribute_new_module/generate_documentation.rst:18
  • Correct the heading typo.
    docs/introduction/architecture_introduction.rst:31
  • Correct the German spelling in the English link text.
    docs/contribute/development/python/python_coding_guidelines.rst:73
  • Correct the misspelling in the new traceability requirement.
    docs/introduction/version_control_introduction.rst:29
  • GitHub is a hosting and collaboration platform, not the version-control tool itself. This introduction should identify Git as the VCS and GitHub as the repository host to avoid teaching the wrong distinction.

Comment thread docs/safety/fdr_reports_safety_analyses_DFA.rst
Comment thread docs/quality/qms_report.rst
Comment thread docs/quality/qms_report.rst
Comment thread docs/quality/qms_report.rst
Comment thread docs/quality/qms_report.rst
Comment thread docs/index.rst Outdated
Comment thread docs/contribute/index.rst Outdated
Comment thread docs/contribute/general/pullrequest.rst Outdated
Comment thread docs/contribute/general/pullrequest.rst Outdated
Comment thread docs/index.rst
antonkri
antonkri previously approved these changes Aug 27, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: AndreasMittag <andreas.mittag@etas.com>
masc2023
masc2023 previously approved these changes Aug 27, 2026

@PandaeDo PandaeDo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rework on it. I described some observations and stopped reading after a while. Looking forward for a new version to continue

Comment thread docs/contribute/contribute_new_module/generate_documentation.rst Outdated
Comment thread docs/contribute/development/traceability_guidelines.rst
Comment thread docs/contribute/feature_request/feature_request.rst
Comment thread docs/contribute/feature_request/feature_request.rst
Comment thread docs/contribute/general/folder_structure_convention.rst
Comment thread docs/contribute/general/issue.rst
Comment thread docs/introduction/integration_introduction.rst
@anmittag
anmittag dismissed stale reviews from masc2023 and RolandJentschETAS via fbeb944 August 27, 2026 11:33
@anmittag
anmittag marked this pull request as draft August 27, 2026 11:36
@anmittag
anmittag marked this pull request as ready for review August 27, 2026 11:54
@anmittag
anmittag requested a balanced review from Copilot August 27, 2026 11:54

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 79 out of 102 changed files in this pull request and generated no new comments.

Suppressed comments (10)

Previously missed (7) — in code that hasn't changed since the last review.

docs/introduction/useful_links.rst:58

  • This URL points to contribution_attribution_guideline_guideline.html, but the relocated page is generated from contribution_attribution_guide.rst. The current link therefore leads to a nonexistent page.
    docs/contribute/general/folder_structure_convention.rst:35
  • This is malformed reStructuredText link syntax: the URL is missing its closing > and link-name delimiters, so the sentence will not render as an external link.
    docs/contribute/development/python/python_coding_guidelines.rst:73
  • Correct the spelling of “traceability.”
    docs/introduction/architecture_introduction.rst:31
  • Correct the German word “Architektur” in this English-language page.
    docs/contribute/development/fork/index.rst:255
  • A reStructuredText bullet list must be separated from the preceding paragraph by a blank line. Without it, these capabilities do not render as the intended list and can produce a documentation warning.
`Copybara <https://github.com/google/copybara>`_ synchronizes code between repositories and can
- Mirror internal → public

docs/safety/index.rst:27

  • This index page only inventories safety documents, but :realizes: makes it a second implementation of the safety-tailoring work product alongside the actual Safety Plan (platform_management_plan/safety_management.rst:21). Remove this relation to avoid false traceability and duplicate realization of wp__safety_tailoring.
    docs/index.rst:314
  • The restructuring leaves hard-coded links to deleted paths. docs/contribute/contribute_new_module/create_new_score_module.rst:31,127 still target contribution_attribution.html and contribution_request/index.html; docs/design_decisions/DR-002-proc.md:209,212 still target the old feature-request and architecture locations. Update these callers to the new paths so the move does not introduce 404s.

docs/contribute/index.rst:27

  • Consolidating the former contribution documents drops the top-level guide's ASIL-B/security classification and its realization of wp__sw_development_plan; the replacement is now training-only even though the management plan references it as the contribution process. Preserve both the original development-plan relation and the newly added training relation.
    docs/users_guide/index.rst:33
  • The landing page now directs users here to learn how to build applications, but this valid training document contains only TBD after its two-sentence introduction. Add the promised application guide or keep the navigation target on existing content until this page is complete.
    docs/platform_management_plan/software_verification.rst:144
  • This rename is still incomplete within the same document: line 223 continues to reference doc__platform_safety_plan, while the local Safety Plan now defines doc__safety_plan_platform. Update that remaining occurrence as well so both tailoring links resolve consistently.

Comment thread docs/contribute/contribute_new_module/index.rst
Comment thread docs/score_releases/index.rst
@anmittag anmittag linked an issue Aug 28, 2026 that may be closed by this pull request
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.

Clear Documentation - user and developer perspective

6 participants