Lyric Dev Documentation by MitchellShiell · Pull Request #106 · overture-stack/lyric

MitchellShiell · 2024-10-22T20:38:34Z

The branch is linked and rendered on a single, easy-to-navigate developer hub that beautifully renders all our product documentation from the /docs folder of all our GitHub repositories.

An updated Readme.md file.
A /docs folder with the following basic structure:

.
├── /overview

The Overview Page can be seen here

Setup will be added next (but not included in this round)

An updated contributing file
An updated code_of_conduct file
An updated license.md file

Important

Before going live will need to update any links to the demo discussion board and Netlify deploy preview

joneubank

Great stuff!

…cture in readme (it is in the overview)

* feat: export migration scripts (#113) * export migration scripts * export DbConfig from data-model Export models * export dist path (#116) * Feat #120 - Get previous submissions paginated (#121) * get submission by id * retrieve submissions by category * get submission by organization * relocate submission unit tests * Add customizable callback for post-commit (#126) * on finish commit callback * check record data changes * fix bytes parsing number (#128) * Submit data using JSON format (#133) * remove file reading * Update types.ts * fix typescript error & remove deprecated endpoint * Fix issue comparing Submitted Data property names (#136) * remove invalid keys * refactoring update entity data function * split submitted data unit test file * logging improvement * Fix Delete submitted data issue (#137) * return when record has no data dependencies * filter unique records to delete * eslint rule to enforce curly braces * make curly linting a suggestion warning --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * New Feature - Authentication Middleware Injection (#123) * retrieve username from userSession * rename config file * rename auth middleware * remove unused code * custom auth handler * auth middleware * fix readme typos * auth custom handle error codes * auth write privilege * log module * update auth handler readme * auth configuration * update auth README * updated docker compose file * Update packages/data-provider/src/utils/authUtils.ts Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * Lyric Dev Documentation (#106) * initializing branch for documentation site * templated overview page * minor fix * minor update * minor change * template update * minor + test * updated readme * testing branch commit issue in build * updating contributing & code of conduct * minor update * updated overview page * links * updated image * Updated inline with PR feedback * minor update * netlify link * updated cross referenced urls to docs.overture.bio * removed code of conduct (.github covers this) removed repository structure in readme (it is in the overview) * updated submission system diagram * Update README.md --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * Request user authentication (#141) * auth required on modification endpoints * get submissions by user name * lowercase username variable * update auth custom handler readme * configure protected methods * bypass auth function * 0.9.1 --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> Co-authored-by: Mitchell Shiell <59712867+MitchellShiell@users.noreply.github.com>

* feat: export migration scripts (#113) * export migration scripts * export DbConfig from data-model Export models * export dist path (#116) * Feat #120 - Get previous submissions paginated (#121) * get submission by id * retrieve submissions by category * get submission by organization * relocate submission unit tests * Add customizable callback for post-commit (#126) * on finish commit callback * check record data changes * fix bytes parsing number (#128) * Submit data using JSON format (#133) * remove file reading * Update types.ts * fix typescript error & remove deprecated endpoint * Fix issue comparing Submitted Data property names (#136) * remove invalid keys * refactoring update entity data function * split submitted data unit test file * logging improvement * Fix Delete submitted data issue (#137) * return when record has no data dependencies * filter unique records to delete * eslint rule to enforce curly braces * make curly linting a suggestion warning --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * New Feature - Authentication Middleware Injection (#123) * retrieve username from userSession * rename config file * rename auth middleware * remove unused code * custom auth handler * auth middleware * fix readme typos * auth custom handle error codes * auth write privilege * log module * update auth handler readme * auth configuration * update auth README * updated docker compose file * Update packages/data-provider/src/utils/authUtils.ts Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * Lyric Dev Documentation (#106) * initializing branch for documentation site * templated overview page * minor fix * minor update * minor change * template update * minor + test * updated readme * testing branch commit issue in build * updating contributing & code of conduct * minor update * updated overview page * links * updated image * Updated inline with PR feedback * minor update * netlify link * updated cross referenced urls to docs.overture.bio * removed code of conduct (.github covers this) removed repository structure in readme (it is in the overview) * updated submission system diagram * Update README.md --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * Request user authentication (#141) * auth required on modification endpoints * get submissions by user name * lowercase username variable * update auth custom handler readme * configure protected methods * bypass auth function * Upgrade Lectern Client to 2.0.0-beta.4 (#144) * fix(auth): update customAuthHandler to accpet async functions * #26: Fix Submit new data - Data loss on Submission with multiple files (#148) * fix submit data * small refactor code * Add Validation Endpoint with Configurable Category, Entity, and Field Validation (#124) * Add Validation Endpoint with Configurable Category, Entity, and Field Validation * validator query endpoint * external validation config * update documentation * validator exists endpoint * refactor code for readability --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * 0.10.0 --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> Co-authored-by: Mitchell Shiell <59712867+MitchellShiell@users.noreply.github.com> Co-authored-by: Jon Eubank <joneubank@gmail.com> Co-authored-by: James Lopez <jamestlopez.code@gmail.com> Co-authored-by: Azher2Ali <121898125+Azher2Ali@users.noreply.github.com>

* feat: export migration scripts (#113) * export migration scripts * export DbConfig from data-model Export models * export dist path (#116) * Feat #120 - Get previous submissions paginated (#121) * get submission by id * retrieve submissions by category * get submission by organization * relocate submission unit tests * Add customizable callback for post-commit (#126) * on finish commit callback * check record data changes * fix bytes parsing number (#128) * Submit data using JSON format (#133) * remove file reading * Update types.ts * fix typescript error & remove deprecated endpoint * Fix issue comparing Submitted Data property names (#136) * remove invalid keys * refactoring update entity data function * split submitted data unit test file * logging improvement * Fix Delete submitted data issue (#137) * return when record has no data dependencies * filter unique records to delete * eslint rule to enforce curly braces * make curly linting a suggestion warning --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * New Feature - Authentication Middleware Injection (#123) * retrieve username from userSession * rename config file * rename auth middleware * remove unused code * custom auth handler * auth middleware * fix readme typos * auth custom handle error codes * auth write privilege * log module * update auth handler readme * auth configuration * update auth README * updated docker compose file * Update packages/data-provider/src/utils/authUtils.ts Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * Lyric Dev Documentation (#106) * initializing branch for documentation site * templated overview page * minor fix * minor update * minor change * template update * minor + test * updated readme * testing branch commit issue in build * updating contributing & code of conduct * minor update * updated overview page * links * updated image * Updated inline with PR feedback * minor update * netlify link * updated cross referenced urls to docs.overture.bio * removed code of conduct (.github covers this) removed repository structure in readme (it is in the overview) * updated submission system diagram * Update README.md --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * Request user authentication (#141) * auth required on modification endpoints * get submissions by user name * lowercase username variable * update auth custom handler readme * configure protected methods * bypass auth function * Upgrade Lectern Client to 2.0.0-beta.4 (#144) * feat(provider): add data file template download route by data category * Updating the lectern dependency and fixing imports * Changes related to the feedback * Refactoring the request validation * Refactoring the data-model and code cleanup * fix: Resolving Build failures * Refactor: Minor code fixes and adding routes to files * Refactor: Simplify type annotation * fix(auth): update customAuthHandler to accpet async functions * #26: Fix Submit new data - Data loss on Submission with multiple files (#148) * fix submit data * small refactor code * Add Validation Endpoint with Configurable Category, Entity, and Field Validation (#124) * Add Validation Endpoint with Configurable Category, Entity, and Field Validation * validator query endpoint * external validation config * update documentation * validator exists endpoint * refactor code for readability --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * refactor(dictionary): simplify routes and params to use categoryId * Resolving built issues in schemas.ts * refactor: move categoryId to path param and clean up controller imports and request parsing * 0.11.0 --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> Co-authored-by: Mitchell Shiell <59712867+MitchellShiell@users.noreply.github.com> Co-authored-by: Jon Eubank <joneubank@gmail.com> Co-authored-by: Azher2Ali <121898125+Azher2Ali@users.noreply.github.com> Co-authored-by: James Lopez <jamestlopez.code@gmail.com>

* feat: export migration scripts (#113) * export migration scripts * export DbConfig from data-model Export models * export dist path (#116) * Feat #120 - Get previous submissions paginated (#121) * get submission by id * retrieve submissions by category * get submission by organization * relocate submission unit tests * Add customizable callback for post-commit (#126) * on finish commit callback * check record data changes * fix bytes parsing number (#128) * Submit data using JSON format (#133) * remove file reading * Update types.ts * fix typescript error & remove deprecated endpoint * Fix issue comparing Submitted Data property names (#136) * remove invalid keys * refactoring update entity data function * split submitted data unit test file * logging improvement * Fix Delete submitted data issue (#137) * return when record has no data dependencies * filter unique records to delete * eslint rule to enforce curly braces * make curly linting a suggestion warning --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * New Feature - Authentication Middleware Injection (#123) * retrieve username from userSession * rename config file * rename auth middleware * remove unused code * custom auth handler * auth middleware * fix readme typos * auth custom handle error codes * auth write privilege * log module * update auth handler readme * auth configuration * update auth README * updated docker compose file * Update packages/data-provider/src/utils/authUtils.ts Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * Lyric Dev Documentation (#106) * initializing branch for documentation site * templated overview page * minor fix * minor update * minor change * template update * minor + test * updated readme * testing branch commit issue in build * updating contributing & code of conduct * minor update * updated overview page * links * updated image * Updated inline with PR feedback * minor update * netlify link * updated cross referenced urls to docs.overture.bio * removed code of conduct (.github covers this) removed repository structure in readme (it is in the overview) * updated submission system diagram * Update README.md --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * Request user authentication (#141) * auth required on modification endpoints * get submissions by user name * lowercase username variable * update auth custom handler readme * configure protected methods * bypass auth function * Upgrade Lectern Client to 2.0.0-beta.4 (#144) * feat(provider): add data file template download route by data category * Updating the lectern dependency and fixing imports * Changes related to the feedback * Refactoring the request validation * Refactoring the data-model and code cleanup * fix: Resolving Build failures * Refactor: Minor code fixes and adding routes to files * Refactor: Simplify type annotation * fix(auth): update customAuthHandler to accpet async functions * #26: Fix Submit new data - Data loss on Submission with multiple files (#148) * fix submit data * small refactor code * Add Validation Endpoint with Configurable Category, Entity, and Field Validation (#124) * Add Validation Endpoint with Configurable Category, Entity, and Field Validation * validator query endpoint * external validation config * update documentation * validator exists endpoint * refactor code for readability --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * refactor(dictionary): simplify routes and params to use categoryId * Resolving built issues in schemas.ts * refactor: move categoryId to path param and clean up controller imports and request parsing * fix(docker): resolve docker issues not connecting auth * feat(data): add stream endpoint * feat(view): add view to stream endpoint * feat(transformer): add transformer config * fix(stream): cleanup stream logic and use totalRecords * fix(stream): fix variable increment logic * feat(swagger): add swagger for stream * fix(stream): resolve issues with content-type * fix(readme): add transformer documentation * refactor(stream): remove transformer function * feat(helper): create isDataRecordValue helper function * fix(util): incorrect return boolean * chore(import): remove unused import * chore(logger): update logger message * feat(entityNames): add entity names filter option and comments * feat(swagger): add entityName param * fix(stream): bail if no data is returned * Update Dockerfile * 0.12.0 --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> Co-authored-by: Mitchell Shiell <59712867+MitchellShiell@users.noreply.github.com> Co-authored-by: Jon Eubank <joneubank@gmail.com> Co-authored-by: Azher2Ali <121898125+Azher2Ali@users.noreply.github.com> Co-authored-by: James Lopez <jamestlopez.code@gmail.com>

* feat: export migration scripts (#113) * export migration scripts * export DbConfig from data-model Export models * export dist path (#116) * Feat #120 - Get previous submissions paginated (#121) * get submission by id * retrieve submissions by category * get submission by organization * relocate submission unit tests * Add customizable callback for post-commit (#126) * on finish commit callback * check record data changes * fix bytes parsing number (#128) * Submit data using JSON format (#133) * remove file reading * Update types.ts * fix typescript error & remove deprecated endpoint * Fix issue comparing Submitted Data property names (#136) * remove invalid keys * refactoring update entity data function * split submitted data unit test file * logging improvement * Fix Delete submitted data issue (#137) * return when record has no data dependencies * filter unique records to delete * eslint rule to enforce curly braces * make curly linting a suggestion warning --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * New Feature - Authentication Middleware Injection (#123) * retrieve username from userSession * rename config file * rename auth middleware * remove unused code * custom auth handler * auth middleware * fix readme typos * auth custom handle error codes * auth write privilege * log module * update auth handler readme * auth configuration * update auth README * updated docker compose file * Update packages/data-provider/src/utils/authUtils.ts Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> * Lyric Dev Documentation (#106) * initializing branch for documentation site * templated overview page * minor fix * minor update * minor change * template update * minor + test * updated readme * testing branch commit issue in build * updating contributing & code of conduct * minor update * updated overview page * links * updated image * Updated inline with PR feedback * minor update * netlify link * updated cross referenced urls to docs.overture.bio * removed code of conduct (.github covers this) removed repository structure in readme (it is in the overview) * updated submission system diagram * Update README.md --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * Request user authentication (#141) * auth required on modification endpoints * get submissions by user name * lowercase username variable * update auth custom handler readme * configure protected methods * bypass auth function * Upgrade Lectern Client to 2.0.0-beta.4 (#144) * feat(provider): add data file template download route by data category * Updating the lectern dependency and fixing imports * Changes related to the feedback * Refactoring the request validation * Refactoring the data-model and code cleanup * fix: Resolving Build failures * Refactor: Minor code fixes and adding routes to files * Refactor: Simplify type annotation * fix(auth): update customAuthHandler to accpet async functions * #26: Fix Submit new data - Data loss on Submission with multiple files (#148) * fix submit data * small refactor code * Add Validation Endpoint with Configurable Category, Entity, and Field Validation (#124) * Add Validation Endpoint with Configurable Category, Entity, and Field Validation * validator query endpoint * external validation config * update documentation * validator exists endpoint * refactor code for readability --------- Co-authored-by: Leonardo Rivera <leorivera_88@hotmail.com> * refactor(dictionary): simplify routes and params to use categoryId * Resolving built issues in schemas.ts * refactor: move categoryId to path param and clean up controller imports and request parsing * fix(docker): resolve docker issues not connecting auth * feat(data): add stream endpoint * feat(view): add view to stream endpoint * feat(transformer): add transformer config * fix(stream): cleanup stream logic and use totalRecords * fix(stream): fix variable increment logic * feat(swagger): add swagger for stream * fix(stream): resolve issues with content-type * fix(readme): add transformer documentation * refactor(stream): remove transformer function * feat(helper): create isDataRecordValue helper function * fix(util): incorrect return boolean * chore(import): remove unused import * chore(logger): update logger message * feat(entityNames): add entity names filter option and comments * feat(swagger): add entityName param * fix(stream): bail if no data is returned * Update Dockerfile * #79: Enable auth to read data (#157) * enable auth to read data * read access validation * filter repository by organization * custom request user session * code refactoring * 0.13.0 * version 0.13.0 --------- Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com> Co-authored-by: Mitchell Shiell <59712867+MitchellShiell@users.noreply.github.com> Co-authored-by: Jon Eubank <joneubank@gmail.com> Co-authored-by: Azher2Ali <121898125+Azher2Ali@users.noreply.github.com> Co-authored-by: James Lopez <jamestlopez.code@gmail.com>

MitchellShiell added 9 commits October 15, 2024 16:41

initializing branch for documentation site

5daccbc

templated overview page

1dabb13

minor fix

6318a4f

minor update

bad5384

minor change

c701ad7

template update

b3863c9

minor + test

d976668

updated readme

d7e1627

testing branch commit issue in build

2a784a9

MitchellShiell mentioned this pull request Oct 22, 2024

🎻 Conductor overture-stack/prelude#20

Merged

MitchellShiell added 3 commits October 22, 2024 16:47

updating contributing & code of conduct

f548c64

minor update

5049455

updated overview page

4d6ca52

MitchellShiell requested a review from joneubank October 24, 2024 14:12

MitchellShiell marked this pull request as ready for review October 24, 2024 14:14

joneubank reviewed Oct 24, 2024

View reviewed changes

Comment thread README.md

Comment thread docs/02-lyric.md Outdated

Comment thread docs/02-lyric.md Outdated

Comment thread docs/02-lyric.md Outdated

Comment thread docs/02-lyric.md Outdated

links

90cfefd

MitchellShiell mentioned this pull request Nov 1, 2024

Deployment Checklist overture-stack/docs#10

Open

29 tasks

updated image

ddc45b0

MitchellShiell changed the title ~~[WIP] - Lyric Dev Documentation~~ Lyric Dev Documentation Nov 2, 2024

MitchellShiell added 4 commits November 2, 2024 18:02

Updated inline with PR feedback

fc8fd98

minor update

f459ba2

netlify link

30396f6

updated cross referenced urls to docs.overture.bio

62b719d

MitchellShiell requested a review from joneubank November 25, 2024 17:26

joneubank approved these changes Nov 26, 2024

View reviewed changes

Comment thread code_of_conduct.md Outdated

MitchellShiell added 2 commits November 26, 2024 17:00

removed code of conduct (.github covers this) removed repository stru…

ac59d52

…cture in readme (it is in the overview)

updated submission system diagram

54ecc6b

MitchellShiell mentioned this pull request Jan 14, 2025

Merge all "bridge" repos to main overture-stack/docs#21

Closed

8 tasks

justincorrigible approved these changes Feb 5, 2025

View reviewed changes

leoraba added 3 commits March 7, 2025 16:14

Update README.md

9758dba

Merge branch 'main' into bridgeLyric

3c4329b

Merge branch 'main' into bridgeLyric

ce37ef4

MitchellShiell merged commit b1d289f into main Apr 9, 2025

MitchellShiell deleted the bridgeLyric branch April 9, 2025 18:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lyric Dev Documentation#106

Lyric Dev Documentation#106
MitchellShiell merged 23 commits into
mainfrom
bridgeLyric

MitchellShiell commented Oct 22, 2024 •

edited

Loading

Uh oh!

joneubank left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

MitchellShiell commented Oct 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joneubank left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MitchellShiell commented Oct 22, 2024 •

edited

Loading