Developer Documentation added #114
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
docs/developer/testing/intro.md
Outdated
|
|
||
| We follow a testing workflow in accordance with [The Test Pyramid](https://martinfowler.com/articles/practical-test-pyramid.html#TheTestPyramid), starting with isolated tests and moving towards complete integration for any new feature changes. The different types of tests (in the order that they should be performed) are explained below: | ||
|
|
||
| TODO -> DOnt link. |
Line 34, typing error for Client Path
prasadtalasila
requested changes
Sep 26, 2023
There was a problem hiding this comment.
Please see the changes made in this branch. You can merge those changes and resolve the comments given here.
There are some markdown linting problems. These are not being shown by codeclimate. Can you please check this? Thanks.
| ## Lib-MS Architecture | ||
|
|
||
| ### Class Architecture | ||
| ```mermaid |
There was a problem hiding this comment.
The mermaid diagrams are not being shown in the generated site. I guess the mkdocs.yml and mkdocs-github.yml need to be updated for generating these diagrams.
There was a problem hiding this comment.
Updated, added configuration. Please have a look.
…ture/distributed-demo
| @@ -114,4 +114,4 @@ You can run this script multiple times until the installation is successful. | |||
|
|
|||
| ## Access the application | |||
|
|
|||
| Now you should be able to access the DTaaS application at: <http:>_https://foo.com_</http:> | |||
| Now you should be able to access the DTaaS application at: _https://foo.com_ | |||
|
|
||
| To manage collaboration by multiple developers on the software, a simple [Fork, Branch, PR](https://gun.io/news/2017/01/how-to-github-fork-branch-and-pull-request/) development workflow is in place. Each developer should follow these steps: | ||
|
|
||
| 1. Have an updated fork of the main repository on their account. This should also be added to codeclimate. |
| ``` | ||
| git clone https://github.com/<yourgithubusername>/DTaaS.git | ||
| ``` | ||
| 1. Work on your issue/feature on your personal computer. |
| 1. Work on your issue/feature on your personal computer. | ||
|
|
||
| 1. Any updates/additions to the software should first be committed to your personal fork. | ||
|
|
|
|
||
| ## Operating Softwares | ||
|
|
||
| Ideally, developers should work on Ubuntu/Linux. Other operating systems are not supported inherently and may require additional steps. |
|
|
||
| ## Code Editing | ||
|
|
||
| Any popular code editors can be used to work on the project. VS Code, Sublime Text are a few examples. |
|
|
||
| ## Development Workflow | ||
|
|
||
| To manage collaboration by multiple developers on the software, a simple [Fork, Branch, PR](https://gun.io/news/2017/01/how-to-github-fork-branch-and-pull-request/) development workflow is in place. Each developer should follow these steps: |
|
|
||
| To manage collaboration by multiple developers on the software, a simple [Fork, Branch, PR](https://gun.io/news/2017/01/how-to-github-fork-branch-and-pull-request/) development workflow is in place. Each developer should follow these steps: | ||
|
|
||
| 1. Have an updated fork of the main repository on their account. This should also be added to codeclimate. |
| ``` | ||
| 1. Work on your issue/feature on your personal computer. | ||
|
|
||
| 1. Any updates/additions to the software should first be committed to your personal fork. |
|
|
||
| 1. Any issues that arise codeclimate should also be resolved. | ||
|
|
||
| 1. Once changes are made, they should be tested on personal systems or the [integration server](https://github.com/INTO-CPS-Association/DTaaS/wiki/DTaaS-Integration-Server) . |
|
Code Climate has analyzed commit ba31a95 and detected 654 issues on this pull request. Here's the issue category breakdown:
View more on Code Climate. |
prasadtalasila
added a commit
that referenced
this pull request
Sep 29, 2023
- Adds developer documentation
- Updates user documentation
- Uses mermaid to integrate UML diagrams
into the documentation.
- Uses madge npm package to generate
dependency graphs for source code.
- Corrects the markdown linter configuration to
catch the warnings in markdown files.
|
merged via #117 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added developer documentation: