first attempt to document core #89
Conversation
|
|
||
| ### Agents Infrastructure | ||
| Agents are used to touch system. Its most important feature is that it can be switched to different target which is heavily used during installation. |
There was a problem hiding this comment.
"Agents are used to modify the underlying system". Or at least, add "a" or "the" before "system" 😉
There was a problem hiding this comment.
Thinking it twice, I will ignore the lack of determinants. That would mean adding a lot of comments to the pull request for something that it's easily fixable after merging the content (which is the important part).
|
The headings start with H2 instead of starting with H1. All headings should have one "#" less |
| - Ruby-bindings provide shortcut for constructing paths. See [Yast.path](http://www.rubydoc.info/github/yast/yast-ruby-bindings/Yast#path-instance_method) | ||
|
|
||
| ### Component System | ||
| The core provides component system that allows language agnostic communication between various parts of YaST. Code written in ruby and perl use ruby, respective perl bindings to attach to such system. |
There was a problem hiding this comment.
"use ruby, respective perl binding" I guess there is some word out of order there.
There was a problem hiding this comment.
it mean that code written in ruby use ruby bindings and code in perl use perl-bindings
There was a problem hiding this comment.
Yes, I know. But the sentence was hard to read for me. Shouldn't it be something like "Code written in ruby and perl use the respective ruby and perl bindings"?
|
It would be cool to add a "further documentation" section pointing to yast.github.io, like it's done in https://github.com/yast/yast-ruby-bindings/blob/master/README.md |
|
I'm not sure if we should take the opportunity of this pull request to actually place the link to systemagents.md (stated as TODO), even moving that file to |
|
yes, it make probably sense to do it now |
| Agents for target system are managed by SCR instance. Each agent is attached to its unique path. The path is special YaST data type(TODO link). An agent itself is defined | ||
| by its scrconf file where is specified if some base together with its parameters that should be used or path to a binary if the agent is implemented by script. | ||
| Agents that is implemented in script communicate via YCP protocol and have predefined methods. Agents using base just configure such base. The base are | ||
| library that is registered also to SCR, but without path. It is usually parser, that allows easier reading and writing files. For example of such library see [system agent documentation](http://yast-core.readthedocs.org/en/latest/doc/systemagent). |
There was a problem hiding this comment.
I think you can keep the link local (that is [system agent documentation](doc/systemagent) and it will work locally, within github and in readthedocs.org.
There was a problem hiding this comment.
ah, I don't know it work this way. So I will change it
There was a problem hiding this comment.
Sorry. I forgot the extension in the example. It should be [system agent documentation](doc/systemagent.md). Otherwise it will not work, at least on github.
|
LGTM. BTW, I restarted the Travis build (it failed due to a network temporary problem) but I don't expect it to fail anyways. |
first attempt to document core
No description provided.