docs: Update Document organization structure

[harshanarayana]

Closes #192

Discussion Items

• How do we re structure README from inside the examples ?

[harshanarayana]

@vladimirvivien to help discuss the re-grouping of Examples document, I have done it for two files. Wonder what would be the best way to org them

[vladimirvivien]

@harshanarayana apologies for the late reply.
I think you are on the right track.
I don't think you need to move the markdown docs from the examples directory.
For now, you can just copy them into the docs directory as to keep the examples complete.

[harshanarayana]

For now, you can just copy them into the docs directory as to keep the examples complete.

You mean keep two copies of it ?

[vladimirvivien]

@harshanarayana or keep a README.md in examples that links to where the respective example is documented. That way, if I browse from example directory I can get back to documentation about example.

[ShwethaKumbla]

LGTM

[harshanarayana]

That way, if I browse from example directory I can get back to documentation about example.

I thought I can do this easily and created a few symlinks. Seems like github won't redirect you to the symlink location if you click on the file :( It just show the path for which the current file links to. (The changes are pushed to the branch for now, I will revert them. Leaving them for now just to show you what it looks like.)

Shall I add a section on the docs/README.md that links you to different set of Examples ? cc @vladimirvivien

[vladimirvivien]

Hi @harshanarayana
Apologies for the late reply.
I have added a comment. I think it's almost there.

[vladimirvivien]

@harshanarayana Hi 👋
Please add a table of content here that links to the different sections. That way, when a user clicks on docks directory, the list of available content will be displayed.

[harshanarayana]

Ack. Pushing the changes now.

[vladimirvivien]

@harshanarayana I have one question. Other than that, I think this is ready to go.

[vladimirvivien]

Hi @harshanarayana this line seems to have moved to line 13. I think It is the title and should be at the top, correct?

[harshanarayana]

/Ack. You are right. Let me re order that bit

[harshanarayana]

Done. PTAL when possible @vladimirvivien

[vladimirvivien]

Thanks @harshanarayana

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: harshanarayana, vladimirvivien

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [harshanarayana,vladimirvivien]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment