Links to API Reference are broken

[vyacheslav-pushkin]

Fix in master and release_0_9 (create a separate PR for each).

STR

Generate the documentation site. Instruction..

Open documentation site and click on any API reference link. For example, go to Jmix React UI -> EntityEditor and navigate the link to EntityEditorProps.

AR

Link leads to https://docs-frontend.jmix.io/jmix-frontend-docs/0.x/api-reference/jmix-react-ui/interfaces/_ui_form_form_.entityeditorprops.html which results in 404.

ER

Link leads to https://docs-frontend.jmix.io/jmix-frontend-docs/0.x/api-reference/jmix-react-ui/interfaces/ui_form_form.entityeditorprops.html

Note

It seems that the newer typedoc version has changed the way file names are constructed.

Check all links in the documentation site and make sure they are working.

[owlet1997]

the master branch Page Getting Started /jmix-frontend/docs-build/jmix-frontend-docs/1.0/getting-started/learning-path.html our forum link AR: https://www.cuba-platform.com/discuss/c/jmix/40 ER: https://forum.jmix.io/

[vyacheslav-pushkin]

@ilya-trifonov see above comment from

[owlet1997]

the master branch Page React Client / Observable State with MobX

1. observer link AR: https://mobx.js.org/refguide/observer-component.html ER: probably https://mobx.js.org/react-integration.html

2. observable link AR: https://mobx.js.org/refguide/observable.html ER: https://mobx.js.org/observable-state.html

[owlet1997]

the master branch Page React Client / Forms FieldProps link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-react-ui/interfaces/ui_form_form.fieldprops.html

[owlet1997]

the master branch Page React Client / I18n

react-intl documentation link

AR: https://github.com/formatjs/react-intl/blob/master/docs/README.md

ER: https://github.com/formatjs/formatjs/blob/main/README.md

[owlet1997]

the master branch Page React Client / Security

Security service link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-react-core/classes/app_security.security.html

corresponding methods link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-rest/modules/security.html

getEffectivePermissions link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-rest/classes/cuba.cubaapp.html#geteffectivepermissions

[owlet1997]

the master branch Page Jmix React UI / EntityEditor

EntityEditorProps link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-react-ui/interfaces/ui_form_form.entityeditorprops.html

[owlet1997]

the master branch Page Jmix React UI / NestedEntitiesTableField

NestedEntitiesTableFieldProps link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-react-ui/interfaces/ui_form_form.nestedentitiestablefieldprops.html

[owlet1997]

the master branch Page Jmix React UI / NestedEntitiyField

NestedEntitiyFieldProps link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/1.0/api-reference/jmix-react-ui/interfaces/ui_form_form.nestedentityfieldprops.html

[owlet1997]

the master branch Page REST API

here link

AR: http://files.cuba-platform.com/swagger/7.2 ER: any Jmix page?

[owlet1997]

the master branch Libraries API Reference combo box in the header:

1. All of the links lead to some CUBA pages and broken ER: links lead to Jmix pages
2. Jmix instead of CUBA should be displayed in the link captions

[owlet1997]

the master branch GitHub Home in the header:

AR: link leads to https://github.com/cuba-platform/frontend ER: link leads to https://github.com/Haulmont/jmix-frontend

[owlet1997]

@vyacheslav-pushkin this case should be discussed

All links to Jmix docs lead to Jmix v.0.9 at the master branch, e.g.: https://docs.jmix.io/jmix/0.x/backoffice-ui

Is it correctly or should we lead users to at least v.1.0 pages?

[owlet1997]

the master branch Jmix Frontend UI in the header:

AR: link leads to https://docs.jmix.io/ ER: probably we don't need the link here, it's just a main page caption

[owlet1997]

unable to check the release_0_9 branch because of blocking issue

[owlet1997]

release_0_9 branch

[owlet1997]

Page Jmix Frontend UI Manual / Overview

Jmix Studio block link Jmix Studio AR: https://docs.jmix.io/jmix/0.x/studio/index.html

Jmix REST library block Generic REST API link AR: https://docs.jmix.io/jmix/0.x/rest/index.html

[owlet1997]

Page Jmix Frontend UI Manual / Getting Started

our forum link AR: https://www.cuba-platform.com/discuss/c/jmix/40 ER: https://forum.jmix.io/

[owlet1997]

Jmix Frontend UI Manual / React Client / Getting Started with React Client

1. Both gif pictures is obsolete and should be updated to the current version

2. Exploring the Generated Project AR: the displayed structure is obsolete:

ER: the app's actual structure

[owlet1997]

Jmix Frontend UI Manual / React Client / Where Do I Go From Here?

Generic REST API link AR: https://docs.jmix.io/jmix/0.x/rest/index.html

[owlet1997]

Jmix Frontend UI Manual / React Client / Observable State with MobX

1. MobX link AR: https://mobx.js.org/intro/overview.html ER: https://mobx.js.org/README.html

2. observer link AR: https://mobx.js.org/refguide/observer-component.html

[owlet1997]

Jmix Frontend UI Manual / React Client / Forms

FieldProps link: AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/0.x/api-reference/jmix-react-ui/interfaces/ui_form_form.fieldprops.html

[owlet1997]

Jmix Frontend UI Manual / React Client / I18n

1. Adding New Localized Content react-intl documentation link AR: https://github.com/formatjs/formatjs/blob/main/docs/README.md

[owlet1997]

Jmix Frontend UI Manual / React Client / Backend Model

obsolete directory name:

[owlet1997]

Jmix Frontend UI Manual / React Client / Security

corresponding chapter link Jmix Platform manual link AR: https://docs.jmix.io/jmix/0.x/security

Security Service (Jmix React Core) block

Security service link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/0.x/api-reference/jmix-react-core/classes/app_security.security.html

Jmix REST Utility Methods block

corresponding methods link AR: http:/localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/0.x/api-reference/jmix-rest/modules/security.html

getEffectivePermissions link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/0.x/api-reference/jmix-rest/classes/cuba.cubaapp.html#geteffectivepermissions

[owlet1997]

Jmix Frontend UI Manual / React Core/ AccessControl

Security in Jmix link AR: https://docs.jmix.io/jmix/0.x/security

[owlet1997]

Jmix Frontend UI Manual / React Core / AttrPermAccessControl

AttrPermAccessControlProps link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/0.x/api-reference/jmix-react-core/interfaces/access_control_attrpermaccesscontrol.attrpermaccesscontrolprops.html

Security in Jmix link AR: https://docs.jmix.io/jmix/0.x/security

[owlet1997]

Jmix Frontend UI Manual / React Core / ClientSideDataCollectionStore

Composition relationship

[owlet1997]

Jmix Frontend UI Manual / React Core / AttrPermAccessControl

EntityPermAccessControlProps link AR: http://localhost:63343/jmix-frontend/docs-build/jmix-frontend-docs/0.x/api-reference/jmix-react-core/interfaces/access_control_entitypermaccesscontrol.entitypermaccesscontrolprops.html

Security in Jmix link AR: https://docs.jmix.io/jmix/0.x/security

[owlet1997]

Jmix Frontend UI Manual / React Core / Security

Security in Jmix link AR: https://docs.jmix.io/jmix/0.x/security