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-assets documentation structure with updated TRG 1 #400

Closed
6 tasks
MaximilianHauer opened this issue Sep 16, 2024 · 4 comments
Closed
6 tasks
Assignees
Labels
enhancement New feature or request

Comments

@MaximilianHauer
Copy link
Contributor

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
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Sep 16, 2024
@MaximilianHauer MaximilianHauer changed the title sig#805 - Align documentation structure with updated TRG 1 sig#805 - Align portal-assets documentation structure with updated TRG 1 Sep 16, 2024
@MaximilianHauer MaximilianHauer moved this from NEW USER REQUEST to BACKLOG in Portal Sep 16, 2024
@MaximilianHauer
Copy link
Contributor Author

@oyo assigned it to you please take a look. we need to start with this TRG adjustments

@oyo
Copy link
Contributor

oyo commented Oct 22, 2024

@evegufy @MaximilianHauer currently we only have user and developer docs. Developer doesn't really cover architecture so I suggest to keep that and create additional empty folders as a starting point for admin and architecture. API is also created with a reference to the API Hub.

@MaximilianHauer
Copy link
Contributor Author

sounds fine for me

@evegufy
Copy link
Contributor

evegufy commented Oct 23, 2024

@evegufy evegufy closed this as completed Dec 2, 2024
@github-project-automation github-project-automation bot moved this from IN PROGRESS to USER READY in Portal Dec 2, 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

3 participants