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

Better Documentation #211

Closed
7 of 15 tasks
akshatdubeysf opened this issue May 17, 2021 · 4 comments · Fixed by #245
Closed
7 of 15 tasks

Better Documentation #211

akshatdubeysf opened this issue May 17, 2021 · 4 comments · Fixed by #245
Assignees
@harshitmitSF

Comments

@akshatdubeysf
Copy link
Contributor

akshatdubeysf commented May 17, 2021 •
edited
Loading

Describe the bug
The documentation is not clear and complete in the current state.

Expected behavior
The documentation should be clear and easy to understand, for all the services and examples.

Services

Examples

  • Audit Example
  • Auth Basic MS Example
  • Auth Multitenant Example
  • In-mail Example
  • Notification Socket Example
  • Scheduler Example
  • Video-conferencing Example
  • Workflow Example
@akshatdubeysf
Copy link
Contributor Author

@sumiter92

@samarpan-b
Copy link
Contributor

We also need to replace mention of loopback4-microservices-catalog with Sourceloop, all through the readmes. Also add link to https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/DEVELOPING.md in root readme

@akshatdubeysf
Copy link
Contributor Author

@harshitmitSF can you check this comment now?

@harshitmitSF
Copy link
Contributor

@harshitmitSF can you check this comment now?

yes sir

harshitmitSF added a commit that referenced this issue Jun 24, 2021
@harshitmitSF
docs(all readme): updated readmes
5c0eb59 
gh-211
harshitmitSF added a commit that referenced this issue Jun 24, 2021
@harshitmitSF
docs(all readme): updated readme
138bb69 
gh-211
@harshitmitSF harshitmitSF mentioned this issue Jun 24, 2021
Merged
12 tasks
akshatdubeysf added a commit that referenced this issue Jul 5, 2021
@akshatdubeysf
docs(authentication-service): fix readme of all services
c451ea8 
GH-211
@akshatdubeysf akshatdubeysf mentioned this issue Jul 5, 2021
Merged
10 tasks
akshatdubeysf added a commit that referenced this issue Jul 7, 2021
@akshatdubeysf
docs(authentication-service): fix readme of all services
2896528 
GH-211
yeshamavani added a commit that referenced this issue Jul 12, 2021
@yeshamavani
docs(core): rebasing readme changes
da6cd3f 
gh-211
yeshamavani pushed a commit that referenced this issue Jul 12, 2021
@akshatdubeysf @yeshamavani
docs(authentication-service): fix readme of all services
4f6fb14 
GH-211
yeshamavani added a commit that referenced this issue Jul 12, 2021
@yeshamavani
docs(core): rebasing readme changes
2d16f94 
gh-211
yeshamavani added a commit that referenced this issue Jul 12, 2021
@yeshamavani
docs(core): deleting dist
d738c59 
gh-211
samarpan-b pushed a commit that referenced this issue Jul 12, 2021
@akshatdubeysf
docs(all-services): fix readme of all services (#245)
b8937fa 
gh-211
@akshatdubeysf akshatdubeysf reopened this Jul 21, 2021
akshatdubeysf added a commit that referenced this issue Jul 23, 2021
@akshatdubeysf
fix(bpmn-service): fix readme for bpmn service
6b6865d 
GH-211
samarpan-b pushed a commit that referenced this issue Jul 26, 2021
@akshatdubeysf
fix(bpmn-service): fix readme for bpmn service (#278)
299535b 
GH-211
yeshamavani pushed a commit that referenced this issue Jul 30, 2021
@akshatdubeysf @yeshamavani
fix(bpmn-service): fix readme for bpmn service (#278)
b753fc7 
GH-211
yeshamavani pushed a commit that referenced this issue Aug 12, 2021
@akshatdubeysf @yeshamavani
fix(bpmn-service): fix readme for bpmn service (#278)
26270a1 
GH-211
yeshamavani pushed a commit that referenced this issue Aug 25, 2021
@akshatdubeysf @yeshamavani
fix(bpmn-service): fix readme for bpmn service (#278)
0525038 
GH-211
yeshamavani pushed a commit that referenced this issue Sep 2, 2021
@akshatdubeysf @yeshamavani
fix(bpmn-service): fix readme for bpmn service (#278)
263a358 
GH-211
akshatdubeysf added a commit that referenced this issue Sep 2, 2021
@yeshamavani @samarpan-b
@akshatdubeysf @jamescrowley321
feat(sandbox): example of pubnub as a provider in notification service (
e30a0ed 
#279)

* feat(sandbox): example of pubnub as a provider in notification service

MIGRATION CHANGE:
migration-20210716062747- notification migration
migration-20210501132806- notification migration

gh-208

* feat(sandbox): sonar fix

MIGRATION CHANGE:
migration-20210716062747- lint fix

gh-208

* fix(core): upgrade loopback4-soft-delete

gh-0

* fix(bpmn-service): fix readme for bpmn service (#278)

GH-211

* feat(sandbox): add-tf-to-sandbox (#263)

* feat(sandbox): k8s-yaml-to-hcl (#280)

* feat(sandbox): pubnub example

gh-208

* feat(sandbox): pubnub example

gh-208

* feat(sandbox): basic-ci-setup (#298)

* feat(sandbox): example of pubnub as a provider in notification service

MIGRATION CHANGE:
migration-20210716062747- notification migration
migration-20210501132806- notification migration

gh-208

* feat(sandbox): add-tf-to-sandbox (#263)

* feat(sandbox): k8s-yaml-to-hcl (#280)

* feat(sandbox): pubnub as a provider

gh-208

* docs(sandbox): ading docs for pubnub config

gh-208

Co-authored-by: Samarpan <samarpan.bhattacharya@sourcefuse.com>
Co-authored-by: akshatdubeysf <77672713+akshatdubeysf@users.noreply.github.com>
Co-authored-by: James Crowley <jamescrowley151@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@harshitmitSF harshitmitSF

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(all-services): fix readme of all services sourcefuse/loopback4-microservice-catalog
3 participants
@samarpan-b @akshatdubeysf @harshitmitSF