Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sig#805 - Align portal-shared-components documentation structure with updated TRG 1 #315

Closed
6 tasks
MaximilianHauer opened this issue Sep 16, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@MaximilianHauer
Copy link

Description

To enhance the consistency and ease of understanding of our products for the open community, TRG 1 was updated.
Make sure to comply with the updated structure:

repository
└─── docs/
    └─── architecture/
    └─── admin/
    └─── user/
    └─── api/
    └─── README.md

Please TRG 1.05-1.08 for more information:
https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-05
https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-06
https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-07
https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-08

Acceptance Criteria

  • Adjust the repo related documentation based on trg 1.05 - gather all architecture documentations into docs/architecture
  • Adjust the repo related documentation based on trg 1.06 - gather admin related docu into docs/admin
  • Adjust the repo related documentation based on trg 1.07 - gather end-user related documentation into doc/user
  • Adjust the repo related documentation based on trg 1.08 - Clarify the setup with Evelyn ;)
  • Adjust the docs/README.md regarding your changes
  • Ensure that all documentation is in English

Additional Information

@MaximilianHauer MaximilianHauer added the enhancement New feature or request label Sep 16, 2024
@MaximilianHauer MaximilianHauer added this to the Release 24.12 milestone Sep 16, 2024
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Sep 16, 2024
@MaximilianHauer MaximilianHauer moved this from NEW USER REQUEST to BACKLOG in Portal Sep 16, 2024
@MaximilianHauer MaximilianHauer moved this from BACKLOG to IN REVIEW in Portal Oct 22, 2024
@MaximilianHauer
Copy link
Author

MaximilianHauer commented Oct 22, 2024

@evegufy would you have a look and close the story ? lftm

@evegufy evegufy closed this as completed Oct 24, 2024
@github-project-automation github-project-automation bot moved this from IN REVIEW to USER READY in Portal Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

2 participants