Documentation-patch submission for Apache issues

Submitting a patch for a documentation issue is same as submitting a patch for a code issue. Only thing to be noticed is where the source code for sites resides. Here I am sharing the steps in a very basic level as helpful for a beginner, from identifying an issue to the submission of patch.

Note:The sample commands I am using here are for linux and for other environments the relevant commands should be applied for same functionality.
  • After identifying the issue from Apache issue navigator, check out the relevant files directory from apache SVN. 
  • Navigate to the relevant .xml files and do the improvements or corrections needed and make sure the xml validation is done and the document is presented as it is intended to be. 
  • Lets see how the changes are applying. In the top level directory that includes all the changes and improvements enter the following command. 

eg : svn co http://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/src/site/xdoc/

eg: svn diff -x-p

You will see something as follows,



- lines preceded with - are to be deleted

- lines preceded with + are to be added

Make sure those are the intended changes and then create the patch with the following command:
Now submit the patch at the jira issue page as follows and add any meaningful comments.

svn diff ><the preferred name for patch file>

eg: svn diff >AXIS2-4655.patch




Keep in touch for updates on the patch submitted. Keep contributing.

Popular posts from this blog

Signing SOAP Messages - Generation of Enveloped XML Signatures

Image
Digital signing is a widely used mechanism to make digital contents authentic. By producing a digital signature for some content, we can let another party capable of validating that content. It can provide a guarantee that, is not altered after we signed it, with this validation. With this sample I am to share how to generate the a signature for SOAP envelope. But of course this is valid for any other content signing as well. Here, I will sign The SOAP envelope itself An attachment  Place the signature inside SOAP header  With the placement of signature inside the SOAP header which is also signed by the signature, this becomes a demonstration of enveloped signature. I am using Apache Santuario library for signing. Following is the code segment I used. I have shared the complete sample here to to be downloaded . public static void main(String unused[]) throws Exception {         String keystoreType = "JKS";         String keystoreFile = "src/main/resour
Read more

How to convert WSDL to Java

Image
Background Basically WSDL (Web Services Development Language) is an XML document used to describe or locate web services. WSDL stands for Web Services Description Language. The document describes a Web service. It specifies the location of the service and the operations that can be taken.  WSDL2Java is distributed with Axis2 package of Apache and need to set-up Axis2 to use this service. A  guide to set-up Axis2  can be found in apache organization documents .WSDL 2.0 is the currently using version. Obviously JDK should be properly installed too. Note: For the 3rd method you are not needed to set these things by yourself. The WSDL document includes server Java programs for Web services and generated classes using WSDL2Java feature includes client stubs, server skeletons and data types that can help in writing client side. The generated stub classes play a great role in distributed computing and if you are interested can read on  what are stub classes . In brief talking, 
Read more

How to Write a Custom User Store Manager - WSO2 Identity Server 4.5.0

Image
With this post I will be demonstrating writing a simple custom user store manager for WSO2 Carbon and specifically in WSO2 Identity Server 4.5.0 which is released recently. The Content is as follows, Use case Writing the custom User Store Manager Configuration in Identity Server You can download the sample here. Use Case By default WSO2 Carbon has four implementations of User Store Managers as follows. org.wso2.carbon.user.core.jdbc.JDBCUserStoreManager org.wso2.carbon.user.core.ldap.ReadOnlyLDAPUserStoreManager org.wso2.carbon.user.core.ldap.ReadWriteLDAPUserStoreManager org.wso2.carbon.user.core.ldap.ActiveDirectoryLDAPUserStoreManager Let's look at a scenario where a company has a simple user store where they have kept customer_id, customer_name and the password (For the moment let's not worry about salting etc. as purpose is to demonstrate getting a custom user store into action). So the company may want to keep this as it is, as there may be other serv
Read more