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.

Sign up for GitHub

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

Jump to bottom

Update developer documentation #97

Closed
prasadtalasila opened this issue Sep 5, 2023 · 3 comments
Closed

Update developer documentation #97

prasadtalasila opened this issue Sep 5, 2023 · 3 comments
Assignees
@astitva1905
Labels
documentation Improvements or additions to documentation
Milestone
Release 0.3.0

Comments

@prasadtalasila
Copy link
Contributor

prasadtalasila commented Sep 5, 2023 •
edited
Loading

  1. Move the existing developer / technical presentation, research paper to the developer section and update the video to the latest presentation.
  2. Add the content of docs/developer to developer section.
  3. One page of technologies used and the way they are used within the project. Perhaps a table followed by an explanation column would be suffice.
  4. One page on the development workflow followed in the project and the quality checks performed during development.

Page layout

Developer
  Index
     - presentation, video
     - development workflow
  System Engineering
      - Architecture (Explanation of Components with links to dedicated pages of components)
      - Website (technology stack, development pointers by linking to README.md page of client/, design documents / diagrams)
      - Gateway
      - Library Microservice
  Testing
    - Different kinds of tests (links to autolabcli pages)
    - Integration and E2E tests in DTaaS
    - Integration Server (link to the wiki page)

Notes:

  1. The UML diagrams are to be written as Mermaid diagrams
  2. Other diagrams to be exported as png diagrams
@prasadtalasila prasadtalasila changed the title Update user documentation Update developer documentation Sep 5, 2023
@prasadtalasila prasadtalasila added this to the Release 0.3.0 milestone Sep 5, 2023
@prasadtalasila
Copy link
Contributor Author

More useful information - E2E tests and testing

@prasadtalasila
Copy link
Contributor Author

The document for diagrams: https://squidfunk.github.io/mkdocs-material/reference/diagrams/

@prasadtalasila prasadtalasila added the documentation Improvements or additions to documentation label Sep 27, 2023
@prasadtalasila
Copy link
Contributor Author

completed in PRs #114 and #117

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

@astitva1905 astitva1905

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Release 0.3.0
Development

No branches or pull requests
2 participants
@prasadtalasila @astitva1905