Bug 5601

Summary:	Merging the Glossary and the Variable Context sections
Product:	[Documentation] Mega Manual	Reporter:	Belen Barros Pena <belen.barros.pena>
Component:	mega-manual	Assignee:	Scott Rifenbark <srifenbark>
Status:	RESOLVED WONTFIX	QA Contact:
Severity:	enhancement
Priority:	Medium	CC:	belen.barros.pena, bluelightning, kristi, richard.purdie, srifenbark
Version:	unspecified
Target Milestone:	Future
Hardware:	x86
OS:	Multiple
Whiteboard:	20 January 2015: IN PROGRESS REVIEW
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	No (bug/feature does not impact docs)

Description Belen Barros Pena 2013-11-25 18:41:16 UTC

In order to provide variable context information within Toaster via documentation.conf, the Reference Manual should add context information to each variable, instead of providing context information in a separate section.

The context information should be synced with documentation.conf, together with the short description (see bug 5600)

Comment 1 Scott Rifenbark 2014-04-01 21:57:23 UTC

Enhancement moving to 1.7.

Comment 2 Scott Rifenbark 2014-05-22 08:46:57 UTC

Changing to future.

Comment 3 Scott Rifenbark 2014-06-16 11:38:26 UTC

I am adding some design notes for when this bug is worked on (post 1.7).

The solution for this bug is tied in with Bug 6158, which is related.  Part of the description for each variable will provide this context information along with the best place for a user to set that configuration up (e.g. local.conf, distro, etc.).

For the YP manual side:

 * I need to isolate variable context information for each variable.
   The information will be appropriate for the documentation.conf file.
 
 * The context information should appear as part of the normal variable
   description.
   
 * The context information needs to be wrapped in a DocBook ID string such 
   that an outside script can easily find the string by processing the 
   ref-variables.xml file.

For the Script side (engineering)

 * Need to create a script that will process the ref-variables.xml file
   and extract the context information for each variable.  The information
   will be used in the documentation.conf file so that it does not
   have to be hand-edited.

Comment 4 Scott Rifenbark 2015-01-30 21:10:36 UTC

I have moved this bug to IN PROGRESS REVIEW.  See bug 5600 for complete details.

Scott

Comment 5 Scott Rifenbark 2015-03-30 22:02:38 UTC

Not sure where we stand on this either.  The descriptions are in the variable entries.  I think I am going to back out the PNG files that would have been used for context.  I don't think we have time for this.

scott

Comment 6 Paul Eggleton 2015-03-31 12:59:57 UTC

I think we'll have to leave this for 1.9 unfortunately.

Comment 7 Scott Rifenbark 2015-09-22 15:28:12 UTC

Setting the perfect days to 3.0 for this.

Comment 8 Scott Rifenbark 2017-09-25 15:51:37 UTC

Closely tied with Bug 5600, which has been inactive for quite some time.  Can we call this done?

Comment 9 Paul Eggleton 2017-09-25 19:28:48 UTC

I think we can probably say it's unlikely we'll get to the corresponding functionality in Toaster, so we can close this for now.

Comment 10 Scott Rifenbark 2017-09-25 20:26:02 UTC

Perfect -- I set the doc flag to "No" in this case. 

Thanks