Skip to content
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

Closed
wants to merge 2 commits into from
Closed

Point all 'ncm' links at corresponding 'readthedocs' pages #639

wants to merge 2 commits into from

Conversation

GooBall
Copy link

@GooBall GooBall commented Nov 24, 2015

Partially resolves quattor/quattor.github.com#128

@hpcugentbot
Copy link

Automatic reply from Jenkins: Can I test this?

@jrha jrha changed the title All 'ncm' links to point at corresponding 'readthedocs' pages Point all 'ncm' links at corresponding 'readthedocs' pages Nov 24, 2015
@jrha
Copy link
Member

jrha commented Nov 24, 2015

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/>.
Copy link
Member

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?

@jrha
Copy link
Member

jrha commented Dec 2, 2015

A fair point. Are the component man pages actually usable or useful?

@jrha jrha added this to the 15.12 milestone Dec 2, 2015
@stdweird
Copy link
Member

stdweird commented Dec 3, 2015

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.
so for developers, it's usable, since they are reading the code anyway (assuming the pods are inlined), but to be really usable, we need quattor/release#105

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.

@jrha
Copy link
Member

jrha commented Dec 3, 2015

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 man can even find them on our systems.

Of course the pod documentation is useful, the question is which output format we should be aiming for.

@stdweird
Copy link
Member

stdweird commented Dec 3, 2015

@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.
if you are volunteering to rewrite all pods in whatever endformat you prefer, that's also ok. but something in between is not needed i think.

@jrha jrha closed this Dec 7, 2015
@jrha jrha removed this from the 15.12 milestone Dec 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Invalid links in documentation
4 participants