search

EiffelWebFramework / EWF

Eiffel Web Framework -- Provide a common framework to build easily web server application in Eiffel (portable on various connector and platforms)
http://eiffelweb.projects.eiffel.org/
Other
44 stars 26 forks source link

Orientation/Learning Documentation #141

Closed ljr1981 closed 9 years ago

ljr1981 commented 10 years ago

The code in this pull request comprises of two parts:

  1. Documentation as orientation or learning material. Some in class and class-feature note clauses and others in NOTES.txt (which--at it turns out--is not going to be my ultimate suggestion, but simply where we started).
  2. Some changes I needed to get EWF to run on my local machine.
oligot commented 10 years ago

Awesome work ! @ljr1981 I'd like to use what's in NOTES.txt to replace the overview on the official website: http://eiffelwebframework.github.io/EWF/index.html Are you ok with that ?

jocelyn commented 10 years ago

I did not read all messages from Larry, so maybe most of my question are already answered. Anyway, to briefly give a general comment on this pull request:

Even if I found this usage of notes too verbose and too constraining to documentate a feature, I could like it for class notes. But now I am wondering if this is related to "ask.eiffel.com" project you mentioned? Do you intend to process those "notes" to help finding an answer to specific questions?

Otherwise, there are a few parts to fix (typo or wrong description), but the general contribution is appreciated, and of quality. As Olivier said, we should reuse your notes.txt for the EWF website, and I agree (modulo the part to fixed).

Other point, did you shared this documentation format specification with other Eiffel users? On the mailing list? (I may have missed it), but what is the feeling from other Eiffel users?

Before adopting it or rejecting such format, it would be good to hear from the community.

For now, thanks for this contribution, it will be integrated, under this form or another, for sure.

As a general comment, we were suggesting for a while to stop using the github wiki for documentation, and instead use README.md or README.wiki included in the various folder, and then we could browse them directly from github source code browser. So this could be reusing the content of NOTES.txt, but using the markdown format that enable to browse easily. And we could have a tool, that scan EWF's repository to produce HTML documentation.

jocelyn commented 9 years ago

Hi Larry,

Right now, we can not merge this pull request without changes. And there is valuable contribution in your pull request. So I could try to merge part of it manually, but this may takes some time. In any case, I don't want to waste the effort you made on this contribution, so the good parts will be updated and integrated.

Now if anyone is willing to help and/or update this pull request, that would speed up the process.

Regards

ljr1981 commented 9 years ago

You can delete it actually.

jocelyn commented 9 years ago

Closing by user request.