How to contribute knowledge

When you post a user knowledge to TUBAME community of ithub on, you can use the pull requests Github.

The following is required to pull the request user knowledge of TUBAME.

github account

You also need to take advantage of Eclipse EGIT plug-in, Eclipse EGIT plug-ins are pre-installed in this procedure.

Knowledge post to TUBAME community is the following flow.

Fork of user knowledge
Clone of user knowledge
Import and check out the user's knowledge
Create a branch
Create Knowledge
Push and commit, pull request

Please forks a user-knowledge from the URL below

URL:https://github.com/TUBAME/user-knowledge

open the Git Repoistires View from Eclipse

Window → Show View → Other → Git → Git Repositories

clone a user-knowledge repository can fork

Git Repoistires View → Clone a Git Repositories

Note

Please enter the following in the URL. https://github.com/(github user name of your)/user-knowledge.git

Then Next → Master → Next → Finish

The Finish later, user-knowledge repository is registered in the Git Repoistires View.

Check out user-knowledge

Git Repoistires View → user-knowledge → FETCH-HEAD → Right click → CheckOut

Note

User-knowledge will be expanded to the Working Directory of Git Repoistires View
Importing Eclipse project as a user-knowledge

Git Repoistires View → Working Directory → user-knowledge → Right click → Import Project

Note

Imports Project Wizard Please: After starting

Imports Project Wizard → Wizard for projects → Import as general project → Next → Finsih

create a branch

Project Explorer → Team → Switch To → new Branch

Note

The Wizard starts, please enter your name in the branch Branch name.

Check mark will be given to the branch that you created when you successfully completed Git Repoistires View → user-knowledge → Branches → (作成したブランチ)

Reference to the following 「knowledge creating more」, to create a knowledge

Add the target file

Project Exploer → Select the file to be changed → Right click → Team → Add
Commit of the target file

Project Exploer → Select the project → Commit
Push

Project Exploer → Select the project → Remote → Push

Note

Please to Push the tag that you created in the repository of your github account
Pull request

Note

Please perform the pull request from github your account

I show below the structure of the knowledge management tool. Knowledge management tool is composed of knowledge and knowledge entry editor and view

Knowledge entry view

I will add, reference, update and delete knowledge entry view on the knowledge of the individual. Knowledge that you create can be used for documentation, etc. as an item.

Figure 1. Knowledge entry view
Knowledge editor

Knowledge editor, is composed of the three tabs:
1. Knowledge Details
  
  It is an editor to edit DocBook#Article contents in the form of knowledge. It is also possible to perform a right-click in the editor, you want to insert the tag templates.
  
  Important
  
  To prevent chapters is the collapse section is create your own, you can not use the section tag.
  
  Figure 2. Knowledge detail screen
2. Check items
  
  You can edit the information search and check information items selected in the knowledge entry view.
  
  Figure 3. Check items screen
3. Documentation
  
  You can edit the chapter structure of the HTML document to be created. We will continue to constitute a document by creating after the heading, to drag-and-drop a category from the knowledge entry view.
  
  Figure 4. Documentation screen

	Important
To prevent chapters is the collapse section is create your own, you can not use the section tag.

I described below how to create knowledge.

Open user knowledge of XML files (UserKnowledge.xml)

Open With → Other → Knowledge editor
Operation of knowledge entry view

Knowledge of each int ther knowledge view , I will add, reference, update and delete Knowledge that you create can be used for documentation, etc. as an item. Knowledge entry view ,will start in one of the following methods
- The automatic start after creating a new XML knowledge
- Starting from the view menu of the Eclipse
  
  Window → Show View → Other → Knowledge management tools → Knowledge entry view

Creating items that constitute the knowledge

Perform the following steps to create the item. For the item does not have any one, first you will want to create a category without fail.

(Selection of items) → Right click → Register any menu → Registration Wizard starts

	Note
	If it is not select an item, it can only be created category

	Note
	In addition to the above, you can also create by copy & paste

The items that make up the knowledge is also available in the following.。 I lists the description of each item below.

Table 1. Item types

Item	Description
Category	An item corresponding to the chapters and sections that configure a document. It contains title information.
Knowledge	An item corresponding to knowledge content described in the chapters and sections that configure a document. It contains `DocBook#Artile` format content information.
Check item	An item that contains information whether or not corresponding knowledge will need to be ported. It contains information such as search processes , porting factors , difficulty and other information.
Search information	A search logic item that the Portability Evaluator uses during searches.

Operation of knowledge editor

Refer to 「Creating items that constitute the knowledge」 below, to manipulate the knowledge editor, please create a knowledge.

	Note
	If you are working with (UserKnowledge.xml) user knowledge XML file in the TUBAME community, "Sample knowledge" has been registered as a sample. For the item of user knowledge in the knowledge entry view , please do.

(Selection of items) → Right click → Create Category → Create Category Wizard starts

Figure 1. Create Category screen

	Note
	Please register the category name

Create knowledge (Select a Category Items) → Right click → Create knowledge → Create knowledge Wizard starts

Figure 1. Create knowledge screen

Note

please register the name of knowledge

Knowledge content editing Knowledge Details

Figure 2. ナレッジ詳細タブ

	Note
	By using the knowledge details tab, please create content in DocBook format HTML preview can be content that you have created. (Editor area of knowledge detail tab) → Right click → HTML Preview

	Warning
	About the content material Image file If you want to specify the image file in mediaobject tag, please specify the path relative to the project. Text file If you want to specify a text file in programlisting tag to specify the relative path from plugins / tubame.knowhow_ * / resources / xsl knowledge management (tubame.knowhow) plug-in

Create a check item (Selection of knowledge items) → Right click → Create checkItem → Create checkItem Wizard starts

Figure 1. Create checkItem screen

Figure 2. Check item information registration Wizard screen

Note

Can be registered in only check item name in the check item information registration Wizard. After registration can be edited in check items tab by double-clicking the check item information.。

I gives a description of each input item of check items information you want to edit in the check items tab below

Table 1. Check Item Information

Item

Description

Search process

Provide an overview of which port items registered as knowledge should be searched and how they should be searched.

Conduct a search

Select this checkbox to conduct searches using the Portability Evaluator .

Porting factor

Searches items that correspond to the reason for the need to port code.

Difficulty

Selects the difficulty of porting work.

	Note
	The criteria used for selection are described below. High Requires major rewriting of the implementation involving major changes to the implementation, settings and other changes. Medium Requires minor rewriting of the implementation. Low Can be handled by minor rewriting that does not affect implementation. Unknown Unknown difficulty Impossible to port Impossible to port

Difficulty details

Selects difficulty details of porting work.

Note

The criteria used for selection are described below.

High

Involves a high level of difficulty.
Medium

Involves a Medium level of difficulty.
Low 1

Items that involve a low level of difficulty but cannot be processed by simple replacement.
Low 2

Items that involve a low level of difficulty and can be processed by simple replacement.
Unknown 1

Difficulty is unknown and JBoss does not have a function for determining difficulty.
Unknown 2

Difficulty is unknown and it is not even known whether JBoss has an applicable function for determining difficulty.
Impossible to port

Involves a level of difficulty that makes Impossible to port .

Visual check

Enter criteria or investigation methods of visual checks when set logical search conditions are not enough to define items that need to be ported.

Inquiry check

Enter items to be checked with developers when the need for porting cannot be determined without checking with the developer.

Add seach info (Select a Check Items) → Right click → Add Search Info → Add Search Info Wizard starts

Figure 1. Add Search Info screen

Figure 2. Add search info wizard screen

Against TUBAME dependence search tools for dynamic analysis by using the analyzer, TUBAME knowledge-based search tool to search all data as text. Key elements that can be set in the TUMABE knowledge management tool is as follows.

Search for files

specify the search file
Search keyword

Parameter there are two. I can specify a search keyword1 and search keyword2.
- search keyword1
  
  If the search only one keyword1 is specified, I will output the rows that the key is present.
- search keyword2
  
  If the keyword 1 and keyword 2 is specified, for a file that matches the keyword 1, and search for the keyword 2 In addition, it prints the line that matches the key keyword 2.
Search module file

Specifies only when performing a search on XPATH XML file.

Figure 1. Setting screen (CheckItem) search of knowledge management tools

Table 1. Search Information

Item

Description

Target search file

Enter the name of files subject to search. Regular expressions can be used in entries.

Search keyword 1

Enter the parameters that will be passed to the search module. Regular expressions and XPath entries can be made.

	Note
	The parameters that can be entered differ with the search module. Enter parameters using the search module overview as reference.

Search keyword 2

Enter the parameters that will be passed to the search module. Regular expressions and XPath entries can be made.

	Note
	The parameters that can be entered differ with the search module. Enter parameters using the search module overview as reference.

Search module

Select the module to search based on the search module overview.

	Note
	If not selected, the standard search function is used for the search. The standard search function performs searches using search keyword 1 and then search keyword 2 to search files found among Target search files.

Search Module overview

Displays a description of the search module overview.

Line count calculation

Select this checkbox when the value in the Line count field should be added as porting man-hours when a search returns a hit.

Reason for not calculating

Enter the reason when line count calculation should be ignored.

Unknown/TODO

When the line count is not finalized, select an applicable item.

Line count

Enter the rough number of lines that should be rewritten during porting.

Line count basis

Enter the reason for the entered line count.

Investigation details

Enter the investigation method for calculating the number of lines that will be rewritten.

Shows how to specify the search criteria type the following three as the search criteria, do a search well below (JAVA / XML / JSP).

As a search example of JAVA file, I want to search for classes that use the weblogic.utils.FileUtils.

Table 1. Search example of JAVA file

Search for files	Search Keywords1	Search Keywords2	Search module
*.java	weblogic\.utils\.FileUtils	FileUtils

	Note
	For a class name generic would also be available to other libraries such as FileUtils, as visual confirmation item, please enter the visual confirmation item.

Search as an example of the JSP file, its own tag in a JSP file: to find that you are using (wl cache).

Table 1. Search example of a JSP file

Search for files	Search Keywords1	Search Keywords2	Search module
*.jsp	wl:cache

Search as an example of an XML file, to search print-nulls tag is being used in weblogic.xml.

Table 1. Search example of an XML file

#	Search for files	Search Keywords1	Search Keywords2	Search module	備考
1	weblogic.xml	print-nulls			TEXT Search
2	weblogic.xml	//jsp-descriptor/print-nulls		ext_search_xpath	XPATH search

If you want to search by XPATH, if you are searching for a namespace in the XML to search for, please set the search criteria as follows.

Table 2. Search example of the XML file being searched for is using the namespace

#	Search for files	Search Keywords1	Search Keywords2	Search module
3	weblogic.xml	//[local-name()='jsp-descriptor']/[local-name()='print-nulls']		ext_search_xpath

	Warning
	The search conditions search Example 2 of the XML file, weblogic.xml Because of the use of the name space, please specify the search Example 3.

You can create the documentation tab than the chapters of the document

Create chapeter

File → New → Other → Knowledge XML file

The chapters of the document documentation You can create more

(Right-click in the documentation editor) → Create chapeter → Create chapeter Wizard starts

Figure 1. Heading creation screen

Figure 2. Create chapeter Wizard screen

Figure 3. Screen of heading after creation

Note

Please enter the name heading. We will continue to constitute a document by creating after the heading, drag and drop a category from the knowledge entry view.

Figure 4. Drag-and-drop screen

Figure 5. Screen drag-and-drop screen after

I will confirm in HTML preview the entire document

(Editor menu) → HTML Preview
I want to save documents into HTML files with

(Editor menu) → Save HTML
I saved as an XML document knowledge

(Editor menu) → save XML

Figure 1. (From left, Save HTML, Save XML, HTML preview) editor menu screen

How to contribute knowledge

1.Overview

1.1.Operating environment

2.Posts flow of knowledge

2.1.Posts flow

2.1.1.Fork of user knowledge

2.1.2.Clone of user knowledge

2.1.3.Import and check out the user's knowledge

2.1.4.Create a branch

2.1.5.Create knowledge

2.1.6.Push and commit, pull request

3.The knowledge by creating knowledge management tool

3.1.Tool Configuration

3.2.Create more information on knowledge

3.2.1.Create items that constitute the knowledge

3.2.1.1.Create categories

3.2.1.2.Create Knowledge

3.2.1.3.Create check item

3.2.1.4.Creation of search information

3.2.1.4.1.How to set the search criteria

3.2.1.4.1.1.JAVA file search

3.2.1.4.1.2.JSP file search

3.2.1.4.1.3.XML file search

3.3.Documentation

3.3.1.Create chapeter

3.4.Save the file and document review

	Note
	User-knowledge will be expanded to the Working Directory of Git Repoistires View

	Note
	Please to Push the tag that you created in the repository of your github account

	Note
	Please perform the pull request from github your account