Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Nov 29 2019 04:53

    mckayERP on develop

    GitBook: [develop] one page mod… (compare)

  • Nov 26 2019 14:48

    mckayERP on develop

    GitBook: [develop] one page mod… (compare)

  • Nov 26 2019 14:45

    mckayERP on v3.9.1

    GitBook: [v3.9.1] 4 pages and 4… (compare)

  • Nov 26 2019 14:45

    mckayERP on develop

    GitBook: [develop] one page and… (compare)

  • Sep 30 2019 14:12
    homebeaver edited #17
  • Sep 30 2019 14:06
    homebeaver edited #17
  • Sep 30 2019 08:46
    homebeaver opened #17
  • Jun 13 2019 21:19

    mckayERP on develop

    GitBook: [develop] 2 pages modi… (compare)

  • Jun 13 2019 21:07

    mckayERP on develop

    GitBook: [develop] 5 pages modi… (compare)

  • Jun 13 2019 15:26

    mckayERP on develop

    GitBook: [develop] one page mod… (compare)

  • May 02 2019 13:36

    mckayERP on develop

    GitBook: [develop] 31 pages and… (compare)

  • May 02 2019 12:48

    mckayERP on develop

    GitBook: [develop] 4 pages and … GitBook: [contrib_213] 11 pages… GitBook: [contrib_213] no pages… and 3 more (compare)

  • May 02 2019 12:45
    mckayERP opened #16
  • Mar 05 2019 18:42

    mckayERP on v3.9.1

    GitBook: [master] 7 pages and 4… GitBook: [master] 5 pages and 1… GitBook: [develop] 9 pages and … and 22 more (compare)

  • Mar 05 2019 18:42
    mckayERP closed #15
  • Mar 05 2019 18:41
    mckayERP opened #15
  • Mar 05 2019 18:08

    mckayERP on develop

    GitBook: [develop] one page mod… GitBook: [contrib_0220] 19 page… Merge pull request #14 from mck… (compare)

  • Mar 05 2019 18:08
    mckayERP closed #14
  • Mar 05 2019 18:08
    mckayERP opened #14
  • Feb 21 2019 20:25

    mckayERP on develop

    GitBook: [contrib_mm0823] 11 pa… GitBook: [contrib_mm0823] no pa… GitBook: [contrib_mm0823] no pa… and 10 more (compare)

Michael McKay
@mckayERP
There are several options for document maintenance out there. We need one that is
Michael McKay
@mckayERP
  1. free and unconstrained
  2. supports collaboration by many users
  3. requires little effort to maintain (as in servers, software, setup etc...)
  4. has version control and ideally would follow the SDP
  5. Uses simple markup or ideally, no markup (markup adds complexity and prevents collaboration)
  6. WYSIWYG is good.
  7. Able to handle rich content
Michael McKay
@mckayERP
Things I think we don't need:
  • ability to publish static books. With the nature of the Internet, video, moving GIFs, and embedded content are all part of the documentation. We do not need page formatting, numbering and a printable format to the output.
  • complex editors or any editors. If people require extra software or have to learn about it, it will limit collaboration.
Michael McKay
@mckayERP
Challenges and issues I don't have a solution for:
  • updating user documentation from the software with up-to-date screen shots. This should be automated and generated from the software/database itself but isn't. It could also be part of the application itself, replacing the current "Help" data. The AD info is updated, but only in the software. The equivalent info is not maintained in our documentation.
  • increasing the number of collaborators and writers - its the least fun job in open-source.
Michael McKay
@mckayERP
Here is why I like gitbook:
  • its integrated with Github and can follow the same SDP
  • they have recently changed course from a legacy markdown-driven approach to a new rich content format, getting rid of the need to generate pdf, ebook and other static formats.
  • their embedded editor is trivially easy to use and can easily handle rich content.
  • cut and paste from the wiki is possible with no loss (editors will have to be wary about links though)
  • pages can be edited directly in Github and submitted through pull-requests.
Michael McKay
@mckayERP

There are limitations when editing the files in Github:

  • cut and paste from the wiki doesn't preserve the markup.
  • the wiki markup and Github markup aren't compatible.

However, cut and paste does work fine in the Gitbook editor.

This is important as most of the docs are already in the wiki and a simple way of importing all that data would be ideal.

Michael McKay
@mckayERP

Here is an invite to the Gitbook adempiere space. Please use it to try it out for yourselves.

https://www.gitbook.com/invite/adempiere?invite=-LJxaiQpcSiCS_BBpitC

Mario Calderon
@marcalwestf
Thanks @mckayERP ;your comments seem sound and I agree on them. I am reading your comments and links. It'll be interesting to know what others specially Yamel think, because for example he's also working on docs.
homebeaver
@homebeaver
Hi @mckayERP , what about languages support in gitbook? I have had some docu for german users written in markdown. So I could port it to gitbook in a short time. The result is here - as I know language support is planned but not implemented yet. The old wiki is ahead in this point. Nevertheless I like the gitbook approach.
Michael McKay
@mckayERP
@homebeaver If there is no direct support for translation of content or presentation of different languages, we could just link to
e-Evolution
@e-Evolution
@mckayERP how are you
the spanish. comunnity are implement other approatch using markdown
Anybody can see here the approach
we using github and pull request to change control
Michael McKay
@mckayERP
other books. Page by page translation is unlikely as we don't have enough people to do that but we should have a plan as to allow for contributions in other languages.
e-Evolution
@e-Evolution
so other can take spanish guide of 1400 pages :-)
to translat any lenguage
but the approach is because we want show this http://docs.adempiere.io
Michael McKay
@mckayERP
I have a similar question about docs for different versions of software, like in Postgres docs, and hope we can get enough documentation to actually make that realistic.
e-Evolution
@e-Evolution
yes we have a lot the obsolete information
in old wiki , this reason that we want a docs with more order and updated
github and this approach is good , because we can ask other contribute
they only need send a pull request
with the change , we are think release the new documentation under creative common license
Compatible with ADempiere
so this are steps , commit in new repository to documentation , and a script generate in atomaticaly readthedocs
Other open source project are using this same strategy
is very simpel and allow a good control change because is same tha t code
e-Evolution
@e-Evolution
Other importat benebits is read the Docs adjust the content to device
Michael McKay
@mckayERP
What editors work with mkdocs? Can you
e-Evolution
@e-Evolution
I am using IntelliJ
this have a lot the plugins
Michael McKay
@mckayERP
Easily copy from the wiki?
e-Evolution
@e-Evolution
I think that yes
e-Evolution
@e-Evolution
but I can ask @ yamelsenih about the conversion
we also evaluate gitbook , but I not sure if can be integrate using pull request
and other that you can define a theme for your documentation and show nice :-)
e-Evolution
@e-Evolution
@ yamelsenih is posible migrate gitbook to Read the docs
so we hope soon have profesional as this :- https://couchdb.readthedocs.io/en/latest/maintenance/compaction.html
or similar
Brijesh Soni
@ibrijeshsoni
Hello All folks, I ma looking for the document architecture of adempiere 360 LTS ... if anyone have that please share with me.
Michael McKay
@mckayERP
@ibrijeshsoni the wiki is your best source. Wiki.adempiere.net
There have been some additions but it should provide enough info to get you going
Brijesh Soni
@ibrijeshsoni

Hello @/all

I want to have the Adempiere's 360 till 392 All release document require, as I am looking for the specific issue.

Thanks

Brijesh Soni
@ibrijeshsoni

Helo @All,

Is there any application monitoring tool for the Adempiere Application

homebeaver
@homebeaver

Hi @mckayERP - some hints for the Developer Guide:

  • a section with links to design patterns - there are many, just pick one or two
  • a section with links on Best Practices for example https://jlbp.dev/

Have a look to my (de)DevGuide
regards

Michael McKay
@mckayERP
@homebeaver Thanks!