Documentation for example usage of hypertool

In order to be easier for the end user of the project it would be beneficial to provide a dedicated documentation of the different functionalities of hypertool and how it is interact with the native Kubernetes.

Can you check this https://gitlab.eclipse.org/eclipse-research-labs/hyper-ai-project/hypertool/-/blob/master/docs/functionality.rst?ref_type=heads ?

(Unofficially you can check out this link: https://hypertool-dd360f.gitlab.io/functionality.html )

I think that is only one part of the needed documentation. We say that Hypertool will help "to support node registration, discovery, and lifecycle management across the Computing Continuum". How this is happening? What does it change to the native Kubernetes?

As an example: Hypertool enable easier support for registration, discovery, and lifecycle management across the Computing Continuum by adding additional labels and annotations to the register nodes status. This ensure easier discovery and management of the nodes while using the native kubernetes commands. For additional information about the added labels and annotations check section Functionality....

If we add additional commands to help with registration, discovery, and management must be added too.

As of right now, it is not really clear how a user can access the extra info we provide and how can be used. With the suggested additions in the documentation, any user that see the hypertool repo will be informed on what exactly we provide and how we provided.

Thank you for the comments. The additional commands will be included in the next Version and the correspoding documentation will be added at that time. I guess you propose to change the overview text ? https://gitlab.eclipse.org/eclipse-research-labs/hyper-ai-project/hypertool/-/blob/master/docs/deployment_guide.rst?ref_type=heads&plain=1#L6

@manosbampis How to proceed ?

Sorry, I lost the notification. I would suggest to refactor the fuctionality.rst. Adding an Overview text in the start and maybe an example like

"the user can utilize the hypertool functionality with common kubernetes commands such us: kubectl describe node_name" (you can also add other commands that shows the "registration, discovery and management").

I would also add a small section in the Functionality section that says something along the line "In this section we introduce all the addition labels/annotations in node status along with the methodology of how we calculate its value if needed"

Of course these are just my suggestions, you can incorporate the extra info in whatever way you think is the best.

Registration, discovery, and management functionalities are still under dev. Docswill be added progressively as implementation advances.
Regarding the second part, can you please commit your suggestion? You can use the online web editor:
https://gitlab.eclipse.org/-/ide/project/eclipse-research-labs/hyper-ai-project/hypertool/edit/func_docs/-/docs/functionality.rst

I make a commit to the func_docs branch please review it and change the info according to your work. As you know I was not actively involved into the making of this tool an so I can not provide any more info without making a mistake.

mentioned in commit 5c75a3a8

I added a description to the functionality file. The description you included in your commit will be used on the homepage of the documentation.

Ok, I will close the issue now

closed