Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1161674

Summary:	Review quickstart README metadata to optimize it for the Google search
Product:	[Retired] JBoss BRMS Platform 6	Reporter:	sgilda
Component:	Quickstarts	Assignee:	Ryan Zhang <rzhang>
Status:	CLOSED EOL	QA Contact:	Tomas David <tdavid>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	unspecified	CC:	kverlaen, rrajasek
Target Milestone:	ER6
Target Release:	6.1.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-03-27 18:38:41 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description sgilda 2014-11-07 15:32:13 UTC

Description of problem:

See https://issues.jboss.org/browse/JDF-787

The jboss.org development team plans to do the following:

- Parse the first line of each README file to remove the quickstart name prefix and use the rest for Google SEO title. That field is limited to ~55 characters.
- Use the 'Summary:' metadata for the description. This field is limited to 155 characters.

This information is what shows up on the search result page, so the better it better describes the example. 

I went through all the JBoss EAP quickstart README files to shorten the title and lengthen the Summary to be more descriptive. We need to do this for all of the other quickstarts, including:

* BRMS: https://github.com/jboss-developer/jboss-brms-quickstarts

See related JBoss EAP bugs for details:

* https://bugzilla.redhat.com/show_bug.cgi?id=1160776
* https://bugzilla.redhat.com/show_bug.cgi?id=1159374


Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 4 Tomas David 2015-03-10 09:26:16 UTC

The first lines still contain the quickstart name prefix and because of this  first lines of business-resource-planner and decision-table quickstarts are longer then 60 characters.

All the 'Summary:' metadatas have correct length.

Comment 5 sgilda 2015-03-10 10:54:33 UTC

That is fine. As I said in the bug description, the jboss.org web site parses out the quickstart name prefix and it's the portion after the ": " that is used for indexing.

It should also be noted that the above suggeestions are merely guidelines to provide good search results. As long as the text after the quickstart name is approximately 55 characters or the important search terms appear in the first 55 characters, this is fine. In some cases, you simply can't fit the text in that limit and still make it readable, and it needs to be understood.

I am moving this back to ON_QA for these reasons.

Comment 6 Tomas David 2015-03-10 11:06:11 UTC

Then it should be ok. Verified on 6.1.0.ER6.