Re: [PATCH 2/4] check-docs: update non-command documentation list

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

Re: [PATCH 2/4] check-docs: update non-command documentation list

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:54:27

"Philip Oakley" [off-list ref] writes:
One issue I notice a few weeks ago is that `git help --all` does not
list all of the available git help pages, rather it just limits itself
to the available command pages.

This means that new users can't discover those additional help pages
in any easy manner.
That would be a problem _only_ if these "additional help pages" are
of importance for new users.  I do not think things that come from
Documentation/technical and ARTICLES (in Documentation/Makefile)
qualify as such.

I'd be perfectly happy as long as all documents are reachable from
git.html in html-fied documentation (the man pages have equivalent
cross references, I think).

Re: [PATCH 2/4] check-docs: update non-command documentation list

From: Philip Oakley <hidden>
Date: 2016-06-15 22:54:27

From: "Junio C Hamano" <redacted>
"Philip Oakley" [off-list ref] writes:
quoted
One issue I notice a few weeks ago is that `git help --all` does not
list all of the available git help pages, rather it just limits 
itself
to the available command pages.

This means that new users can't discover those additional help pages
in any easy manner.
That would be a problem _only_ if these "additional help pages" are
of importance for new users.  I do not think things that come from
Documentation/technical and ARTICLES (in Documentation/Makefile)
qualify as such.
I'd generally agree with that. I wasn't aware of ARTICLES (in 
Documentation/Makefile), so that's something to I'll need to look at.
I'd be perfectly happy as long as all documents are reachable from
git.html in html-fied documentation (the man pages have equivalent
cross references, I think).
That is generally the tack I was looking of taking. Part of the task is 
making sure the 'right' pages are found from the 'right' places. So 
that, for the beginner needing help (git help --all),  even the 
'everyday  git in 20 commands' and 'User manual' would be listed in the 
available guides section.
-----
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help