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#802: Documentation: Add Process Worker Documentation Section in Asset Repository #351

Closed
jjeroch opened this issue Jun 30, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Jun 30, 2024

Description:
The scope of this ticket is to create a dedicated section under the 'developers' directory in our asset repository for documenting the details of process workers. This section should provide clear and comprehensive documentation on the role and functionality of each process worker, the processes they handle, and the specific details required for development and maintenance purposes.

Tasks:

  1. Create a new directory named 'process_workers' under the existing 'developers' section in the asset repository.
  2. Document the role of each process worker, including its purpose and the processes it handles.
  3. Provide detailed descriptions of each process step, including inputs, outputs, and any relevant algorithms or business logic.
  4. Outline any dependencies, such as external services or data sources, that the process workers interact with.
  5. Ensure documentation includes code snippets, configuration details, and examples where necessary.
  6. Review and validate the documentation for accuracy and completeness.

Acceptance Criteria:

  • A new 'process_workers' section exists under the 'developers' directory in the asset repository.
  • Documentation is clear, structured, and accessible, providing valuable insights into the process workers for new and existing team members.
  • All documentation is reviewed for technical accuracy, clarity, and completeness.
  • Code snippets and examples are tested to ensure they are correct and functional.

NOTE - the table created under eclipse-tractusx/portal-backend#816 is expected to get documented as well

@jjeroch jjeroch added the documentation Improvements or additions to documentation label Jun 30, 2024
@jjeroch jjeroch added this to the Release 2.1.0 milestone Jun 30, 2024
@jjeroch jjeroch added this to Portal Jun 30, 2024
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Jun 30, 2024
@jjeroch jjeroch moved this from NEW USER REQUEST to BACKLOG in Portal Jun 30, 2024
@jjeroch jjeroch changed the title Documentation: Add Process Worker Documentation Section in Asset Repository sig#802: Documentation: Add Process Worker Documentation Section in Asset Repository Jul 16, 2024
@jjeroch jjeroch modified the milestones: Release 24.12, Release 24.08 Jul 22, 2024
@Phil91 Phil91 moved this from BACKLOG to IN PROGRESS in Portal Jul 25, 2024
Phil91 added a commit that referenced this issue Jul 29, 2024
Phil91 added a commit that referenced this issue Jul 29, 2024
Reviewed-by: Evelyn Gurschler <[email protected]>
Co-authored-by: Evelyn Gurschler <[email protected]>
Refs: #351
@Phil91 Phil91 moved this from IN PROGRESS to IN REVIEW in Portal Jul 29, 2024
@MaximilianHauer
Copy link
Contributor

@Phil91 did review the merged doc adjustment evtly you can push one behind that fixes some of my findings if they are valuable
#368 (review)

Phil91 added a commit that referenced this issue Aug 9, 2024
Phil91 added a commit that referenced this issue Aug 12, 2024
Phil91 added a commit that referenced this issue Aug 14, 2024
Phil91 added a commit that referenced this issue Aug 14, 2024
Phil91 added a commit that referenced this issue Aug 14, 2024
@MaximilianHauer
Copy link
Contributor

approved

@github-project-automation github-project-automation bot moved this from IN REVIEW to USER READY in Portal Sep 13, 2024
Phil91 added a commit that referenced this issue Sep 16, 2024
@evegufy evegufy modified the milestones: Release 24.08, Release 2.1.0 (24.08) Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

4 participants