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.

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

cleanup and improve documentation strategy #1239

Merged
merged 13 commits into from
Jun 28, 2022

Conversation

akphi
Copy link
Contributor

@akphi akphi commented Jun 26, 2022

Summary

  • Make use of new Grammar APIs' returnSourceInformation flag
  • Re-organize @finos/legend-application to better differentiate between application and shared compnents
  • Modularize plan viewer - Closes Feature request: Modularize plan viewer #717
    • Moved this component to legend-application
    • Make use of this component in Legend Query
  • Support align and distribute group of class views in diagram editor
  • Cleanup post Add element path to element dropdown #1240
  • Make it so Studio doc will fetch doc-mapping definition from external URL
    • Refactor documentation service so that each context is associated with a documentation key instead of being associated with its own doc entry
      • The context - documentation key map should be kept in Studio
      • Move the related documentations to the generic documentation shape, i.e. LegendApplicationDocumentationEntry
    • Fetch documentation from urls (multiple urls)
      • Create extension mechanism to allow loading extra URLs for documentation registry
      • Update setup script to generate documentation, setup mock-server for development of future documnetation
      • Move the documentation content out of the codebase
    • Document the hierarchy of doc overdding in the codebase: doc in codebase, doc fetched from URL, doc fetched from config (document about this in the loader of documentation)
      • The previous behavior where related documentations merge when loaded from extensions will be removed, if needed, we can provide a separate extension mechanism to do this (document about this idea)
    • Validate documentation key (use console warning):
      • Make sure we have an extension mechanism to let people pick documentation key to check for
      • Make sure everything from the linked documentation key of virtual assistant entries are checked
      • Run the check after we load the documentation registry

How did you test this change?

  • Test(s) added
  • Manual testing (please provide screenshots/recordings)
  • No testing (please provide an explanation)

Diagram Editor: Align and distribute spacing

diagram.editor.aligner.mov

@changeset-bot
Copy link

changeset-bot bot commented Jun 26, 2022

🦋 Changeset detected

Latest commit: 1e37a89

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 32 packages
Name Type
@finos/legend-extension-dsl-diagram Minor
@finos/legend-application Major
@finos/legend-graph Major
@finos/legend-manual-tests Patch
@finos/legend-shared Major
@finos/legend-studio Patch
@finos/legend-art Patch
@finos/legend-extension-dsl-text Patch
@finos/legend-query Patch
@finos/babel-preset-legend-studio Patch
@finos/eslint-plugin-legend-studio Patch
@finos/legend-dev-utils Patch
@finos/legend-extension-dsl-data-space Patch
@finos/legend-extension-dsl-persistence Patch
@finos/legend-extension-external-store-service Patch
@finos/legend-extension-mapping-generation Patch
@finos/legend-server-depot Patch
@finos/legend-server-sdlc Patch
@finos/legend-studio-app Patch
@finos/legend-studio-extension-management-toolkit Patch
@finos/legend-studio-extension-query-builder Patch
@finos/legend-taxonomy Patch
@finos/legend-taxonomy-app Patch
@finos/legend-graph-extension-collection Patch
@finos/legend-extension-external-language-morphir Patch
@finos/legend-query-app Patch
@finos/legend-extension-external-format-json-schema Patch
@finos/legend-model-storage Patch
@finos/legend-tracer-extension-zipkin Patch
@finos/legend-query-deployment Patch
@finos/legend-studio-deployment Patch
@finos/legend-taxonomy-deployment Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@finos-cla-bot finos-cla-bot bot added the cla-present CLA Signed label Jun 26, 2022
@akphi akphi changed the title Everything cleanup and improve documentation strategy Jun 26, 2022
@codecov
Copy link

codecov bot commented Jun 26, 2022

Codecov Report

Merging #1239 (1e37a89) into master (7b5dfbe) will decrease coverage by 0.03%.
The diff coverage is 16.34%.

@@            Coverage Diff             @@
##           master    #1239      +/-   ##
==========================================
- Coverage   42.20%   42.17%   -0.04%     
==========================================
  Files        1133     1126       -7     
  Lines       50543    50389     -154     
  Branches    11597    11517      -80     
==========================================
- Hits        21332    21250      -82     
+ Misses      29150    29079      -71     
+ Partials       61       60       -1     
Impacted Files Coverage Δ
...nd-application/src/components/VirtualAssistant.tsx 7.14% <0.00%> (ø)
...omponents/shared/BasicValueSpecificationEditor.tsx 12.29% <ø> (ø)
...ication/src/components/shared/CustomDatePicker.tsx 6.72% <ø> (ø)
...cation/src/components/shared/DocumentationLink.tsx 20.00% <ø> (ø)
...application/src/components/shared/LambdaEditor.tsx 21.21% <ø> (ø)
.../components/shared/LambdaParameterValuesEditor.tsx 8.69% <ø> (ø)
...onents/shared/PackageableElementOptionRenderer.tsx 0.00% <0.00%> (ø)
...lication/src/components/shared/TextInputEditor.tsx 19.23% <ø> (ø)
...d/execution-plan-viewer/SQLExecutionNodeViewer.tsx 0.00% <0.00%> (ø)
.../legend-application/src/stores/ApplicationStore.ts 18.18% <0.00%> (ø)
... and 72 more

@akphi akphi marked this pull request as ready for review June 28, 2022 17:05
@MauricioUyaguari MauricioUyaguari merged commit 4dacea1 into finos:master Jun 28, 2022
@akphi akphi deleted the everything branch June 28, 2022 18:14
@akphi akphi mentioned this pull request Jun 28, 2022
3 tasks
jinanisha pushed a commit to jinanisha/legend-studio that referenced this pull request Aug 5, 2022
* update yarn.lock

* cleanup source information handler

* reorganize legend-application

* modularize plan-viewer

* diagram: support align and distribute

* bump dependencies

* rebase post finos#1240

* simplify contextual documentation config

* allow fetching documentation data from external source

* move documentation out to external source and add checker for required doc entries

* minor refactor post finos#1240

* minor fixes

* bump dependencies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-present CLA Signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: Modularize plan viewer
2 participants