jolie / website

The Jolie website
8 stars 8 forks source link

Documentation about HTTP alias is missing #22

Open klag opened 7 years ago

thesave commented 7 years ago

Please, @klag can you be more specific? For instance, giving an example of what is missing (I guess you mean a different aliasing wrt this).

klag commented 7 years ago

I think it is necessary to introduce a brief section where they are explained with some simple example. Otherwise it is difficult for the reader to understand when and how to use them

thesave commented 7 years ago

You are right @klag. Actually, the documentation of web applications is a little scattered between the page on Leonardo and the one on Rest Services.

It could be better to add a page dedicated to "Web Application Patterns" under the "Web Applications" category where we can move concepts loosely related to Leonardo (like querystrings and html forms) and where we explain how to use/implement (unordered):

What do you think about it?

bmaschio commented 7 years ago

@thesave @klag I think we could devide the HTTP information as Jolie used as HTTP server or Jolie as HTTP client and there showing sort of scenario one may find to deal with. This may help the Jolie solution programmer that wants to work with both clients and server HTTP i can decompose the problems in parts For example we could have

and so on with headers http error message type ecc ecc Tnk Balint

thesave commented 7 years ago

Right. I see the two solutions as incremental. We could start by extracting the mentioned patterns into a dedicated page and then, when we have enough patterns/examples, we could split the page between clients and servers.

bmaschio commented 7 years ago

@thesave I agree do you want a hand?

thesave commented 7 years ago

Sorry for the late reply @bmaschio. I definitely welcome a hand :)

A first iteration on this should deal with moving the material from the mentioned pages into a new, dedicated page (e.g., "Web Application Patterns"). We need to be careful when moving existing documentation pieces to preserve external references, e.g., an external link to web_applications/leonardo.html#html-querystrings should point the user to where we moved that piece of information (e.g., a label/panel reporting the move).

I'll give it a go today and report here as soon as I've pushed a stable procedure for it.

thesave commented 7 years ago

Hi, I created a branch [1] to ease the transition to/creation of the Web Application Patterns page. Right now I just transferred the "cookies" section in leonardo.md to the new page [2].

@klag, @bmaschio can you contribute in the page, e.g., with draft sections on headers (how to read/set them) and aliases?

[1] https://github.com/jolie/website/tree/Web-Application-Patterns [2] https://github.com/jolie/website/blob/Web-Application-Patterns/docs/documentation/web_applications/web_application_patterns.md