Updated readme #102
Updated readme #102
Conversation
arnaud-tincelin
force-pushed
the
chores/readme
branch
from
35ba1eb
to
44e83b7
Compare
There was a problem hiding this comment.
There are few changes which takes the repo move away from early working contract and this PR removes some good documentation we need for those scenarios.
We need to discuss especially this is moving away from one of very key AKS use case.
Like I mentioned in one of my comment:
🐛 Why is this removed? Reason? (Like mentioned few times primary contract of this tool is to coexist with az-cli and vscode so lets sync up a meeting with @qpetraroia and @rzhang628 - but we cannot remove this, Collect command is one of the key use for this and supports few AKS scenarios.
|
|
||
| 0. If CLI extension aks-preview has been installed previously, uninstall it first. |
There was a problem hiding this comment.
🐛 Why is this removed? Reason? (Like mentioned few times primary contract of this tool is to coexist with az-cli and vscode so lets sync up a meeting with @qpetraroia and @rzhang628 - but we cannot remove this, Collect command is one of the key use for this and supports few AKS scenarios.
There was a problem hiding this comment.
yes but the kollect doc shall be in the kollect repo. This documentation should be moved. It's not aks-periscope reponsability to know how external tools use it.
Furthermore, to maintain this documentation up-to-date it would mean to watch for new releases of kollect command and update our readme accordingly - this is painful
It's not moving away from any scenario. It's just refocusing on what it's doing: it's a tool to run diagnostics; not a command line
I think we should also mention the integration with vscode which is not documented at all at the moment (no link to the extension repo)
There was a problem hiding this comment.
💡 I have blocked some time this week, might be there is missing information or could be background information, hence you probably are making these changes, the kollect command was written at the same time and was the idea behind this tool. Hence in various places including the internals have updated a readMe file regarding consuming tools here: https://github.com/Azure/aks-periscope#dependent-consuming-tools-and-working-contract
I would recommend that we can improve the documentation by proper - Wiki pages. Which might also include the consensus on other things. Removing the key usability docs from the documentation is a bad idea. We can discuss this in tomorrows catch-up (if possible) leaving this for wider PM visibility.
There was a problem hiding this comment.
Don't you think it's weird to have the code in one repo and documentation in another one, managed by another team? That's why I suggested to put code & doc at the same place. If we agree on this current PR, all doc we remove from here, we shall put it in a PR on the kollect repo and add a link to this repo from our readme. In my opinion, that would make more sense.
There was a problem hiding this comment.
Cool, @rzhang628 - has an idea for workitem to handle this in wiki for this repo. Which sounds like a great plan and thanks for that.
|
closing this as the new read me changes reside here: #186 ❤️☕️🙏 |
No description provided.