eclipsesource / jsonforms2-website Goto Github PK
View Code? Open in Web Editor NEWJSON Forms 2 Website
Home Page: https://jsonforms.io
JSON Forms 2 Website
Home Page: https://jsonforms.io
We should somehow sync the state between the seed and the listings on the website. Copy & paste is probably not the best approach.
When generating API docs via
lerna run build
lerna run doc
within $JSONFORMS_REPO it's tedious to copy the docs over to the website by hand. What I currently do is:
rm -rf $WEBSITE_REPO/public/api/{core, vanilla, material}
cp -r $JSONFORMS_REPO/packages/core/docs $WEBSITE_REPO/public/api/core
cp -r $JSONFORMS_REPO/packages/vanilla/docs $WEBSITE_REPO/public/api/vanilla
cp -r $JSONFORMS_REPO/packages/material/docsl $WEBSITE_REPO/public/api/material
It'd great if we could automate these steps.
Might actual be an JSON Forms issue.
May be related to #27
It was added due to the mos recent MUI update, but it shouldn't be actually necessary.
Redux is now a peer dependency. The tutorial should point out the it must be installed
Link to Landing page should be on Full Logo including text in the upper left corner (see #16)
Tag line: Complex forms in the blink of an eye
Remove Read the Doc button from landing page
Add correct fav icon
Disclaimer on Landing page: Currently we support primarily
Getting started:
http://jsonforms-beta.de/docs/uischema: Box in Blue with info symbol
Docs: Indentation of the 2nd level items in the navigation should be increased otherwise they are on indentation level as selected items in the 1st level.
If possible simply: http://jsonforms-beta.de/docs/uischema should also list on the detail page all subitems as links. (simple, if duplicated, which I did for now)
Why does API doc open in separate window?
At the end: Trigger Website review by Sage (define boundaries!) (see #19)
Add to the support page what we had on http://jsonforms.io/#/support (see #15)
Examples:
http://jsonforms-beta.de/examples/categorization => broken (see respective JSON Forms issue #686)
http://jsonforms-beta.de/examples/custom-controls => Date control broken (fixed in JSON Forms)
Add Twitter link
In the seed, the RatingControl looks like this https://github.com/edgarmueller/jsonforms-react-seed/blob/master/src/rating.control.js, while in the tutorial it is different (see below).
Check if site works in FF.
Failed to minify the code from this file:
./node_modules/@jsonforms/core/node_modules/uri-js/dist/esnext/uri.js:42
See eclipsesource/jsonforms#1198 for more context
Get Started
Button on landing page does not workRead the Docs
Button on landing page does not workInferring a UI schema
Example missingInferring both schema
Example missingCustom controls
Example missingLanding page
: This page lists important articles to get started below. A list of all available articles is available to the **left**.
Will there be an additional list or should this point to the list on the right?Getting started
-> Usage with existing redux store
I don't get the last sentence, maybe I just miss react knowledge.Layouts
Rule
TODO: do we describe anywhere how to initially hide elements?
I don't really get what you want to achieveLayouts
sectionCustom Renderers
Aka web component usage.
/docs/api
banner is shownCore
API
links in /docs/available-actions
link to localhost/docs/available-actions
"ref resolving" link in text points to non-existing path/docs/tutorial
: Materal UI link is broken/docs/uischema/layouts
: Links to layouts are broken/docs/available-actions
multi line API specification should be styled differently/docs/custom-renderers
: NOT_APPLICABL
-> NOT_APPLICABLE
/docs/custom-renderers
: switch -1
with NOT_APPICABLE
/docs/custom-renderers
: enumeration has different font and is misaligned/docs/getting-started
: enumeration has different font and is misaligned/docs/renderer-sets
: Material ui link should link to its main site, not next./docs/uischema/layouts
: First paragraph (in each section) is styled differently/docs/uischema/layouts
: There is only one demo link for one type of layout/docs/uischema/rules
: First paragraph is styled differently/docs/what-is-jsonforms
: How does it work, 2nd paragraph is styled differently/examples/categorization
: Should show both categories initially, looks broken with only one/examples/categorization
: Weird empty horizontal space before first category/docs/renderer-sets
: There should be at least some words about other renderer sets than material and vanilla./docs/getting-started
: command line should be npm ci
instead of npm install
/docs/custom-renderers
: command line should be npm ci
instead of npm install
/docs/getting-started
: getting started and the starting section in /docs/custom-renderers
are redundant. Suggestion: Remove the one of /docs/custom-renderers
and link to /docs/getting-started
or extract a common component and reuse that in both./docs/available-actions
API anchors will not survive any api change, see /docs/available-actions#initdata-any-schema-jsonschema-uischema-uischemaelement-options-initactionoptions--ajvajv
To avoid jumping menus etc when it is toggled between pages
Add them on a single page
For example the Create a JSON Forms App
tutorial does not allow the user to modify the given data. This was reported in https://spectrum.chat/jsonforms/general/bug-in-create-a-json-forms-app-tutorial~8af86298-7878-4238-8ddd-f4b20cb94094
Can we pre-render the landing page?
Looking at the 'Create a renderer', 'Create a tester', 'Register the renderer' sections, there's no mention about where the listed code should go e.g. index.js, rating.control.js etc.
We should display the version of the framework on the website.
To demonstrate the various UI schema elements.
Should happen automatically on push to master
Age
is presented with a validation error is a required property
89
)should be <= 100 should be >= 18 should be integer
The actual option is called showSortButtons
not showSortingButtons
. See https://jsonforms.io/docs/uischema/controls
There are multiple small issues in the Examples:
No applicable renderer found.
No applicable renderer found.
Also see eclipsesource/jsonforms#853 and eclipsesource/jsonforms#854
The description of the Rule example (examples/rule
) says:
This example uses a Rule to display an additional selection control if the 'Is Alive' checkbox is unchecked. If is is checked the control will be hidden. Give it a try!
However, in the example, the additional selection control is enabled when the 'Is Alive' checkbox is checked and is disabled (not hidden) when the checkbox is unchecked.
The example or the description should be updated.
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.