PeachCloud
/
peach-devdocs
0
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Update software readmes #17

Merged
mycognosist merged 8 commits from update_readmes into main 2021-03-04 08:55:27 +00:00
Conversation 0 Commits 8 Files Changed 11 +372 -57
mycognosist commented 2021-03-04 08:53:22 +00:00 (Migrated from github.com)
Copy Link

This PR updates the documentation for all microservices, utilities and the web interface. While the dev-doc pages are not exact replicas of the README for each repo, the key details have been made consistent (ie. API and usage).

Documentation has been added for peach-probe and peach-version-checker under the Utilities category. I have also added a version badge for the web interface.

All docs should now pass the peach-version-checker test. Further automation can be considered in the future.

This PR updates the documentation for all microservices, utilities and the web interface. While the dev-doc pages are not exact replicas of the README for each repo, the key details have been made consistent (ie. API and usage). Documentation has been added for `peach-probe` and `peach-version-checker` under the `Utilities` category. I have also added a version badge for the web interface. All docs should now pass the `peach-version-checker` test. Further automation can be considered in the future.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
  
bug

Something is not working

  
documentation

   
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
invalid

Something is wrong

  
maintenance

Pruning and weeding

  
peach-lib

   
peach-network

   
peach-oled

   
peach-stats

   
peach-web

   
question

More information is needed

  
refactor

Code rewrite

  
wontfix

This won't be fixed

No Label
bug
documentation
duplicate
enhancement
help wanted
invalid
maintenance
peach-lib
peach-network
peach-oled
peach-stats
peach-web
question
refactor
wontfix
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: PeachCloud/peach-devdocs#17
No description provided.
Delete Branch "update_readmes"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?