Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 115924 - update of Docs-user and Docs-developer products
Summary: update of Docs-user and Docs-developer products
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Infrastructure
Classification: Unclassified
Component: Bugzilla (show other bugs)
Hardware: All All
: High normal (vote)
Assignee: Jeffrey Forman (RETIRED)
URL:
Whiteboard:
Keywords:
: 118545 (view as bug list)
Depends on:
Blocks:
 
Reported: 2005-12-18 04:14 UTC by Jan Kundrát (RETIRED)
Modified: 2011-10-30 23:15 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jan Kundrát (RETIRED) gentoo-dev 2005-12-18 04:14:19 UTC
Hi, as pointed out on https://bugs.gentoo.org/show_bug.cgi?id=58651#c29 and again on https://bugs.gentoo.org/show_bug.cgi?id=115791#c2, current list of components for docs-user is a bit outdated. What about some cleanup?

So, I'd propose the following Products instead of docs-user and docs-developer:

a) Documentation (www.gentoo.org/doc/, NOT manapages etc)
a.1) Handbook (w.g.o/doc/en/handbook/)
a.2) Articles (w.g.o/doc/en/articles/)
a.3) Other guides (w.g.o/doc/en/)
a.4) Translated documentation
a.5) Submit new

b) Other documentation
b.1) Project specific docs (w.g.o/proj/en/)
b.2) Manpages
b.3) Other

Let's make a decision and forward it to jforman.
Comment 1 Jan Kundrát (RETIRED) gentoo-dev 2005-12-18 04:15:47 UTC
fixing summary, sorry :-(.
Comment 2 Łukasz Damentko (RETIRED) gentoo-dev 2005-12-18 04:29:04 UTC
Small proposition:
Let's add "development documentation" and let's make all the components automatically fill in "assigned to" field. For our docs and translations it would be docs-team@gentoo.org, for dev docs it would go to devrel@gentoo.org, for man pages to portage team, and so on. Project documentation could go to bug-wranglers, and they would decide to which project assign the bug.
What do you think?
Comment 3 Jan Kundrát (RETIRED) gentoo-dev 2005-12-18 04:49:31 UTC
(In reply to comment #2)
> Small proposition:
> Let's add "development documentation"

What for?

> and let's make all the components automatically fill in "assigned to" field.

Sure, but this is the case already.

> for man pages to portage team

You probably meant bug-wranglers as manpages are usually provided by the respective packages or manpages-$LANG or something...

> Project documentation could go to bug-wranglers, and they would decide to which project assign the bug.
> What do you think?

Yep.
Comment 4 Łukasz Damentko (RETIRED) gentoo-dev 2005-12-18 07:39:25 UTC
(In reply to comment #3)
> > Let's add "development documentation"
> What for?

To have all the bugs in developer handbook by default assigned to devrel, not to us?

> > for man pages to portage team
> 
> You probably meant bug-wranglers as manpages are usually provided by the
> respective packages or manpages-$LANG or something...

I meant gentoo-related man pages like manuals for gentoolkit programs, portage, emerge and so on. Other manuals are made by TLDP or program authors, so mistakes in them should probably go upstream.
Comment 5 Jan Kundrát (RETIRED) gentoo-dev 2005-12-18 08:16:01 UTC
(In reply to comment #4)
> (In reply to comment #3)
> > > Let's add "development documentation"
> > What for?
> 
> To have all the bugs in developer handbook by default assigned to devrel, not
> to us?

Well, Developer's Handbook is under /proj/en/devrel, so it will probably go throught the bug-wranglers as any other project-specific stuff. Doesn't really matter, IMHO.
Comment 6 Łukasz Damentko (RETIRED) gentoo-dev 2005-12-18 08:46:05 UTC
Ok, so as we have agreed on the list and there are no signs of resistance, you can CC jforman probably...

BTW: (question of "yeah, keep dreaming" type)
Maybe we could somehow force users to submit a link to the guide they are referring to in bug reports and, using path, assign it to the appropriate group of people?
Comment 7 Jan Kundrát (RETIRED) gentoo-dev 2005-12-19 05:48:20 UTC
Okay, Jeff, I think we're done. The list in comment 0 is valid. Is it possible to fix that? What about existing bugreports? Could they be converted automagically?
Comment 8 Jeffrey Forman (RETIRED) gentoo-dev 2005-12-24 18:20:38 UTC
Sorry guys, didnt see this one pop up in my email queue. Below are my thoughts:

(In reply to comment #0)
> Hi, as pointed out on https://bugs.gentoo.org/show_bug.cgi?id=58651#c29 and
> again on https://bugs.gentoo.org/show_bug.cgi?id=115791#c2, current list of
> components for docs-user is a bit outdated. What about some cleanup?
> 
> So, I'd propose the following Products instead of docs-user and docs-developer:
> 
> a) Documentation (www.gentoo.org/doc/, NOT manapages etc)
> a.1) Handbook (w.g.o/doc/en/handbook/)
> a.2) Articles (w.g.o/doc/en/articles/)
> a.3) Other guides (w.g.o/doc/en/)
> a.4) Translated documentation
> a.5) Submit new
> 

Okay, documentation is documentation. Whether it's on w.g.o or in the man pages, or written in sanskrit on someone's forehead. I would tend not to split it up in a documentation and "other doc" products.

You dont need a 'submit new' component of the product. That's more a property of the bug status. open, resolved, etc. 

> b) Other documentation
> b.1) Project specific docs (w.g.o/proj/en/)
> b.2) Manpages
> b.3) Other

See above.
 
> Let's make a decision and forward it to jforman.
> 

I'm up for anything that makes sense to me. But one thing I will warn you about. When we rm the old product, its going to send out a shitton of emails. That's just something we cant get around.
Comment 9 Jeffrey Forman (RETIRED) gentoo-dev 2005-12-24 18:22:21 UTC
(In reply to comment #2)
> Small proposition:
> Let's add "development documentation" and let's make all the components
> automatically fill in "assigned to" field. For our docs and translations it
> would be docs-team@gentoo.org, for dev docs it would go to devrel@gentoo.org,
> for man pages to portage team, and so on. Project documentation could go to
> bug-wranglers, and they would decide to which project assign the bug.
> What do you think?
> 

Each component under the product can have a different default assignee. 

Comment 10 Jan Kundrát (RETIRED) gentoo-dev 2005-12-25 06:05:37 UTC
(In reply to comment #8)
> Okay, documentation is documentation. Whether it's on w.g.o or in the man
> pages, or written in sanskrit on someone's forehead. I would tend not to split
> it up in a documentation and "other doc" products.

Okay, so what about something like "Manual Pages" which will assign it to the bug-wranglers?

> You dont need a 'submit new' component of the product. That's more a property
> of the bug status. open, resolved, etc. 

We do, it is for submitting new documentation. It could go under "Other docs under /doc/en/", but it's already included in the current state.

> I'm up for anything that makes sense to me. But one thing I will warn you
> about. When we rm the old product, its going to send out a shitton of emails.
> That's just something we cant get around.

:-(
Comment 11 Xavier Neys (RETIRED) gentoo-dev 2005-12-31 06:49:21 UTC
The bottom line is users can't fill in bugs properly and the GUI is not helping whatsoever.
We currently have two products (docs-user & docs-developer) and the distinction between them is not clear. Besides, their respective component lists are outdated, incomplete and too long.

Couldn't we have two new products with more sensible descriptions & component lists and remove the current doc-* products from https://bugs.gentoo.org/enter_bug.cgi ?
This way we don't have to change anything to current bugs.
Comment 12 Xavier Neys (RETIRED) gentoo-dev 2006-01-15 05:58:30 UTC
*** Bug 118545 has been marked as a duplicate of this bug. ***
Comment 13 Jeffrey Forman (RETIRED) gentoo-dev 2006-01-29 20:15:33 UTC
Not sure whether this bug just went stale. But give me products/components you want. with descritiptions and default assignees for each and I can see on implementing it.
Comment 14 Xavier Neys (RETIRED) gentoo-dev 2006-02-02 14:36:43 UTC
Can the following products be flagged as obsolete and hidden from https://bugs.gentoo.org/enter_bug.cgi?
.Docs-developer: Developer oriented documentation and Tools. This includes portage.
.Docs-user: User oriented documentation.

and be replaced by the following products:

.Documentation: guides and handbooks located under www.g.o/doc and all translations <b>on www.g.o</b>
.Other documentation: project-specific docs (www.g.o/proj), man pages, etc.

Components for first product (all assigned to docs-team):
.Installation handbook (w.g.o/doc/en/handbook/)
.Other documents (w.g.o/doc/en/)
.Translated documentation on www.g.o
.Submit New Documentation

I don't care much what goes into the second product. I guess some projects will want a component entry, like devrel for their handbook. We'd like an entry (GDP, assigned to docs-team). I suppose man pages would go to bug-wranglers.

Does that sound reasonable?
Comment 15 Flammie Pirinen (RETIRED) gentoo-dev 2006-02-02 19:01:54 UTC
How about having translations as separate product with languages as components? This way we wouldn't need to kludgily prefix all translation bugs with [ll] and it could help a lot with filtering translation bugs as well. This is also the method that most other projects (eg. gnome) use to handle translation bugs in bugzilla.

At least it would be nice if something was done to make reporting translation bugs easier, as with current method I keep getting misreported spam from translation teams and translation bug reports at least weekly.
Comment 16 Jan Kundrát (RETIRED) gentoo-dev 2006-02-03 04:33:13 UTC
(In reply to comment #15)
> How about having translations as separate product with languages as components?

Yup, seems like a great idea as long as it's easy for jforman to add new languages. We will have to have an "Other Languages" item as well.
Comment 17 Xavier Neys (RETIRED) gentoo-dev 2006-02-03 05:25:07 UTC
(In reply to comment #16)
> (In reply to comment #15)
> > How about having translations as separate product with languages as components?
> 
> Yup, seems like a great idea as long as it's easy for jforman to add new
> languages. We will have to have an "Other Languages" item as well.

How easy is it to add or remove a language from the component list?
I'd want to restrict the list to the actively maintained languages, and use Other with the language code in the subject as we do now.
FYI, the list of known languages on www.g.o is
pl	de	fr	ja	it	es	ru	pt_br	zh_tw	ro	cs	fi	nl	da	tr	ko	id	hu	pt	sv	vi	lt	ca	el

The component list should only display pl,cs,de,fi,fr,ja,it,es,ru,pt_br,zh_tw,ro,other
Comment 18 Xavier Neys (RETIRED) gentoo-dev 2006-02-03 09:33:12 UTC
Final call, if you disagree, react fast to let jforman know in time.

Docs-developer & Docs-user products should be replaced with:

. Documentation: guides and handbooks located under www.gentoo.org/doc/
. Translations: all documents not in English on www.gentoo.org
. Other documentation: project-specific documentation, man pages, etc. Please try to assign to the project or maintainer in charge.

Components (title, default assignee, description):
. Documentation:
.. Installation handbook, docs-team@gentoo.org, Our main installation handbook.
.. Other documents, docs-team@gentoo.org, All other guides and books. Please fill in the URL field.
.. Submit new document, docs-team@gentoo.org, If you have a brand new document

. Translations: (all go to docs-team)
.. [cs] Czech
.. [de] German
.. [es] Spanish
.. [fi] Finnish
.. [fr] French
.. [it] Italian
.. [ja] Japanese
.. [pl] Polish
.. [pt_br] Brazilian Portuguese
.. [ro] Romanian
.. [ru] Russian
.. [zh_tw] Traditional Chinese
.. Other

. Other documentation
.. Developers HOWTO, devrel@gentoo.org, The Developers HOWTO on creating ebuilds properly and using ports.
.. Portage Documentation, dev-portage@gentoo.org, Man pages, helpful output, etc.
.. Project-specific documentation, bug-wranglers@gentoo.org, Project pages under www.gentoo.org/proj. Please try to assign to the relevant project.
.. Other, bug-wranglers@gentoo.org, If it doesn't fit anywhere else ...

(List inspired by current components, feel free to adjust, not GDP's turf)
Comment 19 Jeffrey Forman (RETIRED) gentoo-dev 2006-02-04 06:22:03 UTC
Done.

DOCS TEAM: YOU NEED TO SEARCH FOR YOUR BUGS (I CLOSED YOUR PREVIOUS PRODUCTS) AND MOVE THEM OVER TO THE NEW SETUP.