WIP: bt reference doc
Unmarked this merge request as a Work In ProgressToggle commit list
Marked this merge request as a Work In ProgressToggle commit list
The reference of some documents changed in erp5.com.
In the table below, I try to map old reference to current references:
Previous reference New reference Comment bt5-Accounting bt5-Accounting bt5-Accounting.Tutorial bt5-Accounting.Tutorial user-Accounting.Guide user-Accounting.Guide french only P-OSOE-Accounting.Mathematician P-OSOE-Accounting.Mathematician bt5-Banking bt5-Banking confusing description "even more complete version of ERP5 banking" bt5-Budget bt5-Budget confusing description "Update TODOs with recent progress and experiences" it was a comment for the change ? developer-Calendar erp5-DesignDocument.Erp5.Calendar.Design developer-Configurator developer-Configurator developer-CRM developer-CRM archived bt5-CRM bt5-CRM developer-CRM and bt5-CRM are almost same ... they are a bit outdated, event workflow is old bt5-dms bt5-dms bt5-HR bt5-HR developer-Item developer-Item developer-Gadget erp5-DesignDocument.Erp5.Gadget.Introduction erp5-Open.Order erp5-Open.Order erp5-payroll-design erp5-payroll-design bt5-Payroll.Howto.Use.Source.And.Destination bt5-Payroll.Howto.Use.Source.And.Destination still only in Submitted state. Recent work by @Nicolas used a different model I believe bt5-Payroll.Model.Schema bt5-Payroll.Model.Schema bt5-Payroll.Paysheet.Transaction.Schema bt5-Payroll.Paysheet.Transaction.Schema developer-Project cancelled. Was probably just a duplicate of erp5-Project erp5-Project erp5-DesignDocument.Project.Management.With.Erp5 developer-Simulation erp5-DesignDocument.Simulation* erp5-New.Simulation This one was not listed developer-Business.Process developer-Business.Process bt-TaxTechnicalNotes ? Could not find, they are all cancelled. The latest version was https://nexedi.erp5.net/document_module/1260 developer-Web ? Could not find it. developer-Create.Web.Widget developer-Create.Web.Widget user-Howto.Edit.Webpage.Fckeditor erp5-HowTo.Edit.Webpages.With.Fckeditor User-Howto.Maintain.Existing.Website erp5-HowTo.Maintain.Existing.Website
I can update this merge request later, but I believe we need a way to be able to automatically check that references are still valid or somethign.
developer-Securitywas not listed either. It changed reference to
@jerome : there are two points for me.
1) how to not have broken links throughout the documentation if references change/are changed. This should be a generic DMS feature.
2) how to connect documentations to bt5
On 1) I was discussing with JP and @tc some time ago and we wanted to set successors (objects a page links to) and predecessors (objects linking to a page) on a page. Once we would index web page implicit successors, then implicit predecessor would be ~`catalog(implicit_successor=self). I'm still not sure when the best time would be to index successors (probably when saving an object) or how to manage finding broken references (something like a website-action-check-consistencies). If you have suggestions here, I'm happy to hear.
For 2) I would prefer something which does not have to be maintained manually. One idea was to add bt5 as sub-categories to products, as we added software solutions to products (ERP5 Software, SlapOS Software, etc.) and documents are selected in web section predicate according to the follow-up (eg no Wendelin Software howto on www.erp5.com/documentation/developer/howto). This would mean having to add the relevant bt5 to every documentation document. It would also make it automatic to list bt5s per software (like on erp5.com/feature) and output documentation per bt5. What do you think about this?
I agree, about 1), there is implicit successor / predecessor that were designed for that, but I don't know how much this is implemented. If there is a constraint using this, we could just use
checkConsistencyto check for broken links.
2) I am not sure about this one, this documentation is supposed to be maintained, read and updated by humans, I don't feel we need to automate more. Maybe we can consider removing / archiving old documentation so that the size remain maintainable if the problem is that there is too much documentation.
About 1), I think what was discussed is:
- at Web Page edition, implicit successors are indexed somewhere ;
- predecessors implicit successors will have to be reindexed too (e.g. in case of validation state change) ;
- implicit successors would point to internal documents only ;
But broken links won't be indexed, of course. So surfing among successor & detecting broken links are different.
We can make an alarm that checks all web page links, implicit successors are useless for this case.
With predecessor, we can detect if a page is never referenced in our sites (e.g.
if not hasPredecessor and not has(publication_section/technical_note) ...).
Thanks for commenting 1) I will look into constraints/check consistency 2) Organizing documentation review is my next milestone, I'll come back to this once I reach it... :)