kyma-incubator / documentation-component Goto Github PK
View Code? Open in Web Editor NEWReact component for rendering markdown, openapi, asyncapi and odata
License: Apache License 2.0
React component for rendering markdown, openapi, asyncapi and odata
License: Apache License 2.0
Description
There is a PR from some time ago regarding the package "merge". However, whitesource has been showing high vulnerability errors (CVE-2020-28499) in Compass Console for quite some time. If the PR is fine, can you merge it so we get rid of the error?
Thanks
Steps to exploit
Risk assessment
[{CVSS Vector String}]({CVSS Calculator URL}) {CVSS Base Score} ({CVSS Base Severity})
Proposed mitigation
Merge the PR
Description
AC:
Description
At the moment we have a pure playground for documentation-component
. We need app like https://www.asyncapi.com/asyncapi-react/ to easy maintain and develop all packages in packages
dir.
AC:
Reasons
For better development experience.
Description
After providing huge spec to odata component, the rendering of component throws error. Please see attachment below.
AC:
Expected result
Odata component works very well with huge spec.
Actual result
Odata component is broken when user provide spec with lots of data.
Steps to reproduce
Provide spec with lots of data to component.
Description
AC:
documentation-component
in catalog and instancesdocumentation-component
in content-uiDescription
AC:
jest
or another testing frameworkdocumentation-component
and only core functionality, like a concatenating options, render content by render engines etc. - testing render engines will be done in next iteration.Related issue(s):
kyma-project/kyma#4025
Description
With the latest update of @kyma-project/dc-async-api-render-engine
in Kyma Console and Compass Console the Async API rendering stopped working.
I've given an example output in the Kyma Console UI in this issue.
The validation seems to fail for async APIs that have null
fields like this one. On older versions of both consoles the APIs are rendered properly.
Expected result
The documents are rendered properly.
Actual result
The validation of fields fails.
Steps to reproduce
Described here
Troubleshooting
Description
Reasons
At the moment all examples for the component are in TypeScript, except of sandbox projects.
Believe it or not, but there is still a great number of javascript developers that do not need TypeScript at all to write good quality code :D https://insights.stackoverflow.com/survey/2019#technology-_-programming-scripting-and-markup-languages
Description
AC:
markdown
render engine etc.Readme.md
file.Description
Documentation component (exactly markdown-render-engine and his plugin headers-extractor
) has a problem with only one instance of SourceWithOptions
or SourceGroupWithOptions
.
Expected result
Documentation component should work with one of above types with single instance.
Actual result
After passing one of above types with single instance, documentation component crash.
Description
As inlined in https://github.com/kyma-project/console/issues/684, we need to make our styles consistent across specification components. This issue is for OData component.
Reasons
To have consistent style across application.
Description
At the moment we have strongly coexisting with React ecosystem in our core. For easier integration in other frameworks (Angular and Vue ecosystem, and maybe also in SvelteJS) we must extract whole React from core and make it independent from any JS lib/framework.
Reasons
For easier integration in other JS frameworks/libs.
Description
Right now, only OData component has proper rollup configuration, and especially documentation-component (not root) should be as small in size as possible.
Reasons
Smaller bundle sizes guarantee better customer experience through shorter loading times.
Description
Reasons
usability of the component out of the box
Description
AC:
documentation-component
package and for others - render engines and for odata-react
.
docs/development
folder like hereReasons
Attachments
Description
Right now all of the run* functions, like runExtractor
for example, are not pure - they modify incoming objects, which makes is harder for us to test it
Reasons
Write better, more testable code
Attachments
Description
In kyma-incubator we use the @kyma-project/dc-async-api-render-engine lib. There was a vulnerability fix in our UI which bumps the @kyma-project/dc-async-api-render-engine to v0.3.5. But it seems like there are no output files in that build. When installing this version in our repo I see only the package.json and the README within the node modules.
Expected result
Have a good build with output js files.
Actual result
No minified file when the package is installed.
Steps to reproduce
Troubleshooting
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.