polycube icon indicating copy to clipboard operation
polycube copied to clipboard

WIP - Updating name and documentation for Transparent HelloWorld Service

Open frisso opened this issue 6 years ago • 5 comments

Added documentation, useful for new developers. It would be nice to shorten the name, so that we can avoid typing "transparenthelloworld" such as in polycubectl transparenthelloworld add trhw0 but I'm unable to do so right now.

frisso avatar Jul 25 '19 16:07 frisso

Let's try; I remember something like the "-" character creates troubles with the code generation :-(

frisso avatar Jul 26 '19 06:07 frisso

Let's try; I remember something like the "-" character creates troubles with the code generation :-(

Yes looks swagger auto-gem compiler has problem to generate correct code if there is "-" character, the character following the "-" will be used to generate variable but some place capital some place small-case and code won't be compiled.

goldenrye avatar Jul 26 '19 19:07 goldenrye

Few comments:

  • - causes problems in the code generation. Infact the duplicated file you removed because of this.
  • I don't know if this is a good idea to change the name on the datamodel without regenerating the code.
  • Long names should not be a problem with bash autocompletion, you don't have to type all of them.

mauriciovasquezbernal avatar Jul 26 '19 21:07 mauriciovasquezbernal

  • Long names should not be a problem with bash autocompletion, you don't have to type all of them.

Unfortunately this is not true. Long names are consuming a lot of space on the screen. Type for instance polycubectl -h and see how columns are large, due to the big name we have. So, I feel we should use shorter names for better visibility.

frisso avatar Jul 27 '19 10:07 frisso

  • Long names should not be a problem with bash autocompletion, you don't have to type all of them.

Unfortunately this is not true. Long names are consuming a lot of space on the screen. Type for instance polycubectl -h and see how columns are large, due to the big name we have. So, I feel we should use shorter names for better visibility.

I soft agree with that, just find a name that is shorter but still meaningful, I think tr-helloworld is a quite good one as suggested above.

mauriciovasquezbernal avatar Jul 27 '19 15:07 mauriciovasquezbernal