Skip to content

Remove duplicated glossary page - #624

Open
PiotrKorkus wants to merge 1 commit into
eclipse-score:mainfrom
qorix-group:piotrkorkus_fix_glossary_dupe
Open

Remove duplicated glossary page#624
PiotrKorkus wants to merge 1 commit into
eclipse-score:mainfrom
qorix-group:piotrkorkus_fix_glossary_dupe

Conversation

@PiotrKorkus

Copy link
Copy Markdown
Contributor

The lifecycle glossary is defined in two places - score_platform and here.

score_platform standalone docs build is ok
lifecycle standalone docs build is ok

ref_int combined build - problem, we have a duplication


This allows both score_platform and lifecycle documentation builds without duplication.

Bugfix

Important

Use this template only for bugfixes that do not influence topics covered by contribution requests or improvements.

Caution

Make sure to submit your pull-request as Draft until you are ready to have it reviewed by the Committers.

Description

[A short description of the bug being fixed by the contribution.]

Related ticket

Important

Please replace [ISSUE-NUMBER] with the issue-number that tracks this bug fix. If there is no such
ticket yet, create one via this issue template.

closes [ISSUE-NUMBER] (bugfix ticket)

avoid duplication by using bundles
@github-actions

Copy link
Copy Markdown
Contributor

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

@NicolasFussberger

Copy link
Copy Markdown
Contributor

I would rather keep the actual glossary in the module repo and adapt the score repo.
Maybe we can have a minimal glossary in the score repo (just enough to cover the terms used in feature requirements), maybe just linking to the glossary in module repo.

All the feature architecture, feature description are in this repo. So in my opinion it would make more sense to have the glossary close to it.

@PiotrKorkus

Copy link
Copy Markdown
Contributor Author

All the feature architecture, feature description are in this repo. So in my opinion it would make more sense to have the glossary close to it.

Thats another thing that is also located in score repo - https://eclipse-score.github.io/score/main/features/lifecycle/architecture/index.html

Im getting confused what should be where, almost every feature has different layout.

One thing I am certain, we cannot make score_platform dependent on all features to pull their parts of documentation, it needs to stay as now that every feature repo deps on score_platform

@NicolasFussberger

Copy link
Copy Markdown
Contributor

All the feature architecture, feature description are in this repo. So in my opinion it would make more sense to have the glossary close to it.

Thats another thing that is also located in score repo - https://eclipse-score.github.io/score/main/features/lifecycle/architecture/index.html

Im getting confused what should be where, almost every feature has different layout.

One thing I am certain, we cannot make score_platform dependent on all features to pull their parts of documentation, it needs to stay as now that every feature repo deps on score_platform

In that case I would still favour to keep the actual glossary here and trim down the glossary in score repo to only what is necessary to understand the content of lifecycle in score repo (which should not be much).
Otherwise it would be a bit tedious for us to keep adapting the glossary in another repo when we work on the documentation in this repo.

@AlexanderLanin

Copy link
Copy Markdown
Member

Im getting confused what should be where, almost every feature has different layout.

Compare https://eclipse-score.github.io/score/main/contribute/general/folder.html and ask Roland Jentsch for further clarifications :-)

@PiotrKorkus

Copy link
Copy Markdown
Contributor Author

Im getting confused what should be where, almost every feature has different layout.

Compare https://eclipse-score.github.io/score/main/contribute/general/folder.html and ask Roland Jentsch for further clarifications :-)

According to this glossary belongs to score_platform repo @NicolasFussberger

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

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

3 participants