Bug 506038

Summary:	Move and update p2 Repository Analyzers documents
Product:	[Technology] CBI	Reporter:	David Williams <david_williams>
Component:	p2 Repository Analyzers	Assignee:	David Williams <david_williams>
Status:	RESOLVED FIXED	QA Contact:	David Williams <david_williams>
Severity:	normal
Priority:	P1	CC:	frederic.gurr
Version:	unspecified
Target Milestone:	---
Hardware:	PC
OS:	Linux
Whiteboard:
Bug Depends on:	487543
Bug Blocks:

Description David Williams

2016-10-16 15:04:23 EDT

There (were) two documents related to "repo reports" in SimRel part of the wiki. 

Those should be (and have been) moved to "CBI" wiki space. 

https://wiki.eclipse.org/CBI/p2repoAnalyzers/Repo_Reports_FAQ
and
https://wiki.eclipse.org/CBI/p2repoAnalyzers/Repo_Reports_Running_Locally

I have updated them so inaccuracies were removed or changed, but some more things should be documented. 

One is the "referenceRepo" parameter. 

Another thing to document is "the build". Just to give location and an overview, if nothing else. 

https://hudson.eclipse.org/cbi/view/p2RepoRelated/job/cbi.p2repo.analyzers.build/

I should also add pointers to current scripts where the "product" or "repository" is used. 

This is partially related to bug 506037.

Comment 1 David Williams

2016-10-16 15:05:55 EDT

FYI, I have updated the "categories" so that CBI category shows these two documents, as well as the aggregator manual. See 

https://wiki.eclipse.org/Category:CBI

Comment 2 David Williams

2016-10-16 21:03:18 EDT

I have update the two documents as much as I can, for now. Improvements always welcome. :) 

https://wiki.eclipse.org/CBI/p2repoAnalyzers/Repo_Reports_FAQ
https://wiki.eclipse.org/CBI/p2repoAnalyzers/Repo_Reports_Running_Locally

As these documents have evolved, I suspect they could be combined. Each is fairly short. The "FAQ", long ago, contained the information that is now in the "main page" itself, on the meaning of each tests (e.g. see 
http://download.eclipse.org/releases/neon/201610111000/buildInfo/reporeports/ )

Comment 3 David Williams

2016-10-17 15:29:45 EDT

I did decide to combine the "run locally" document into the main document. 

Plus, I removed the word "FAQ" from the main document, since it really was not a FAQ. So, final URL is 

https://wiki.eclipse.org/CBI/p2repoAnalyzers/Repo_Reports

Plus, made other modifications to refer to CBI list and bugzilla, instead of cross-project. 

I am also going to remove the version of the document that exists in the Git repo. It would not be that helpful to have in two locations and too much effort to maintain two copies.

Comment 4 David Williams

2016-10-17 15:54:19 EDT

Fred, I added you to CC partially so you will be more aware of this document in 

https://wiki.eclipse.org/Category:CBI

But also to ask if you wanted to "give it a try" -- if nothing else simply from your workspace, on some simple repository, so you can help proof read the document and make sure that it "makes sense" to someone reading it for the first time (well, maybe you already read the old one, but, you know what I mean :)

Comment 5 David Williams

2016-10-17 23:00:27 EDT

I just remembered to add a short paragraph that at least points to the "Hudson build" for these report packages.