-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Point all 'ncm' links at corresponding 'readthedocs' pages #639
Conversation
Automatic reply from Jenkins: Can I test this? |
test this please |
@@ -11,9 +11,9 @@ ncm-accounts: NCM component to manage the local accounts on the machine. | |||
|
|||
The I<accounts> component manages the local accounts on a machine. LDAP | |||
authentication depends on the LDAP configuration, which is handled by | |||
L<ncm-authconfig>. | |||
L<authconfig|../authconfig/>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so how does this work with man
as regular pod files? authconfig
actually exists.
shouldn't we do this conversion in quattor/release#105?
A fair point. Are the component man pages actually usable or useful? |
useful, i'd say yes, since they contain information how the component behaves with having to read most of the code. it certainly helps when modifying methods to read what the method was supposed to do in the first place. if the pod format ideal for the intended usage: probably not, but it's at least a standard and it can be converted to other formats. |
What I mean is, are they more useful as man pages or html on readthedocs? I for one have never looked at the generated man pages and I'm not sure Of course the pod documentation is useful, the question is which output format we should be aiming for. |
@jrha they are more useful as readthedocs for sure. but that needs conversion anyway, so i would keep the pods as pods, and handle the conversion elsewhere. |
Partially resolves quattor/quattor.github.com#128