ADT_Frontend icon indicating copy to clipboard operation
ADT_Frontend copied to clipboard

Published 20 hours ago • verified publisher icon abapGit

documentation

Open larshp opened this issue 7 years ago • 7 comments

Suggest placing somewhere under http://docs.abapgit.org

larshp avatar Jul 26 '18 13:07 larshp

I think we should provide some documentation guides

  • Development Setup Guide (see #18)
  • FAQ

Where should these guides reside? Ideas:

  • Project Wiki?
  • Separate .md files in the project root and linked into README?

absap avatar Aug 02 '18 08:08 absap

in abapGit and abapOpenChecks github-pages are used, via static pages compiled using jekyll.

The github wiki has the disadvantage that it is not possible to submit pull requests for it

First I guess we need to decide what is the nicest url for accessing docs, eg: http://eclipse.abapgit.org (this is the same as suggested for the update site, not sure if they can live together) http://eclipse.abapgit.org/docs http://docs.abapgit.org/eclipse <- I like this one

Information for abapGit development I have collected at http://docs.abapgit.org/development/, so perhaps just a page here can contain the Development Setup Guide?

larshp avatar Aug 02 '18 08:08 larshp

As more and more dev topics come together, I would suggest that we start very soon with a developer documentation. For the beginning, a .md file linked in README.md could do the job.

absap avatar Aug 07 '18 07:08 absap

agree, .md is good for now

larshp avatar Aug 07 '18 07:08 larshp

I'm going to create one

absap avatar Aug 07 '18 07:08 absap

any suggestions for naming the document? dev-guidelines.md

I already prepared a feature branch for it.

absap avatar Aug 07 '18 07:08 absap

dev-guidelines.md is good 👍

larshp avatar Aug 07 '18 07:08 larshp