Openbravo Issue Tracking System - Openbravo ERP
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0045004Openbravo ERPA. Platformpublic2020-09-07 13:302020-09-11 09:38
Reportershuehner 
Assigned Tocberner 
PrioritynormalSeveritymajorReproducibilityhave not tried
StatusclosedResolutionfixed 
PlatformOS5OS Version
Product Version 
Target VersionPR20Q4Fixed in VersionPR20Q4 
Merge Request Status
Review Assigned To
OBNetwork customer
Web browser
ModulesCore
Support ticket
Regression level
Regression date
Regression introduced in release
Regression introduced by commit
Triggers an Emergency PackNo
Summary0045004: Remove obsolete old javascripts docs ui from client.kernel
DescriptionThe client.kernel contains a visualization of javascript code documentation using the jquery library which is accessible in any instance with this relative url:

https://livebuilds.openbravo.com/erp_pi_pgsql/web/org.openbravo.client.kernel/docs/ [^]

That is based on this 3rd party project:
https://code.google.com/archive/p/code-illuminated/ [^]

That was added long time ago and the syntax used for the documentation is very different from the 'jsdoc' syntax used today in i.e. modern retail javascript code.

That old visualization should be deleted as obsolete.
As extra benefit that removes an older version of the jquery library kept just for this.
Steps To Reproduce-
Proposed Solution1.) Delete the whole org.openbravo.client.kernel/docs/ folder
2.) Also remove entry from legal/Licensing.txt referring to the 3rd party project used for this.
3.) Review and cleanup the org/openbravo/client/kernel/DocumentationComponent (and related constant) as it seems to be only used for enumerating js source files for this ?
Additional Information
TagsNo tags attached.
Relationships
related to defect 0045826 closed platform Remove obsolete docs/ and benchmark/ from .eslintignore and .prettierignore 
causes defect 0045028 closed alostale API Change: Remove DocumentationComponent from org.openbravo.client.kernel module 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2020-09-07 13:30shuehnerNew Issue
2020-09-07 13:30shuehnerAssigned To => platform
2020-09-07 13:30shuehnerModules => Core
2020-09-07 13:30shuehnerTriggers an Emergency Pack => No
2020-09-07 13:32shuehnerDescription Updatedbug_revision_view_page.php?rev_id=21653#r21653
2020-09-07 13:35shuehnerProposed Solution updated
2020-09-07 13:48shuehnerTarget Version => PR20Q4
2020-09-09 13:04hgbotNote Added: 0122874
2020-09-09 17:52cbernerAssigned Toplatform => cberner
2020-09-10 14:17cbernerRelationship addedcauses 0045028
2020-09-11 09:38hgbotResolutionopen => fixed
2020-09-11 09:38hgbotStatusnew => closed
2020-09-11 09:38hgbotFixed in Version => PR20Q4
2020-09-11 09:38hgbotNote Added: 0122949
2020-09-11 09:38hgbotNote Added: 0122950
2021-02-01 15:41cbernerRelationship addedrelated to 0045826

Notes
(0122874)
hgbot   
2020-09-09 13:04   
Merge Request created: https://gitlab.com/openbravo/product/openbravo/-/merge_requests/157 [^]
(0122949)
hgbot   
2020-09-11 09:38   
Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/openbravo [^]
Changeset: c2b45e21fe2ea0e429ee5ddb0727fdae55380856
Author: Cristian Berner <cristian.berner@openbravo.com>
Date: 2020-09-11T07:38:26+00:00
URL: https://gitlab.com/openbravo/product/openbravo/-/commit/c2b45e21fe2ea0e429ee5ddb0727fdae55380856 [^]

Fixes ISSUE-45004: Remove obsolete org.openbravo.client.kernel/docs

Those docs were previously generated from javascript with
code-illuminated library. The syntax is very different to the jsdoc used
currently. So it is removed as obsolete, and both library and license
for it are also removed.

Template docs.js.ftl and class DocumentationComponent are also removed
because they're not needed anymore by the module.

---
M legal/Licensing.txt
M modules/org.openbravo.client.kernel/src-db/database/sourcedata/OBCLKER_TEMPLATE.xml
M modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/KernelComponentProvider.java
M modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/KernelConstants.java
R modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/DocumentationComponent.java
R modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/templates/docs.js.ftl
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/docs/docs.css
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/docs/docs.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/index.html
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/scripts/jquery.dynacloud-5.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/scripts/jquery.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/scripts/prettify.css
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/scripts/prettify.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/scripts/wikicreole.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/tests/test_image_in_table.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/tests/test_with_cr.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/tests/test_with_crlf.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/tests/test_with_lf.js
R modules/org.openbravo.client.kernel/web/org.openbravo.client.kernel/docs/tests/tests.html
---
(0122950)
hgbot   
2020-09-11 09:38   
Merge request merged: https://gitlab.com/openbravo/product/openbravo/-/merge_requests/157 [^]