Description:
Adding documentation on the architecture of the Streaming Integration profile.

Suggested Labels:
Streaming-Integration docs

Affected Product Version:
EI 7.0.0

Link
https://github.com/wso2/docs-ei/blob/master/en/streaming-integrator/docs/overview/architecture.md

The docs for setting up databases [1] rewritten [2].

[1] https://docs.wso2.com/display/ADMIN44x/Working+with+Databases
[2] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/setup/databases

This issue is to move the initial drafts of the JSON PAYLOAD docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/json_messages
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

This issue is to move the initial drafts of the data services docs [1] and to update the navigation.

[1] https://docs.wso2.com/display/EI650/Working+with+Data+Services

Jenkins build: https://wso2.org/jenkins/job/docs/job/docs-ei/configure

Sample script:

#!/bin/bash

set -o xtrace

#install needed versions

export LC_ALL=C.UTF-8
export LANG=C.UTF-8

apt-cache show python3
apt-cache show python3-pip

apt-get install python3 -y
apt-get install python3-pip -y
ls /usr/bin/p*

alias python='python3'
alias pip=pip3
alias python

pip install virtualenv
virtualenv /env --python=/usr/bin/python3
export PATH=/env/bin:$PATH
echo $PATH

which python3
which python

pip install --upgrade pip

pip install --upgrade mkdocs
pip install Pygments
pip install pymdown-extensions

pip install -U --no-deps mkdocs-material==4.1.1

which mkdocs
pip install markdown-include

apt-get install jq 

echo == versions ==

pip --version
python --version
mkdocs --version
pip freeze | grep mkdocs-material

echo ==============


echo == Build Script Start ==

cwd=`pwd`

#use for checkout and build a particular branch

build(){

 git checkout $1  
 version=$1
 echo ${version}
    
#rename master to next

 if [ "$1" == "master" ]; then
   version="next"
   echo master branch
 fi
    
#obtain particular lang folder
#create folder structure
#build a particular branch

 for dir in ${cwd}/*/; do      
  if [ -d ${f} ]; then
   dir=${dir%*/}
   dirName=${dir##*/}
    if [ ${dirName} != "dist" ]; then
     mkdir -p dist/${dirName}       
     cd ${dir}

########
ADD NEW LOGIC

cd ballerina-integrator
mkdocs build

cd ../micro-...
mkdocs build

cd ..
mv -f "${cwd}/${dirName}/ballerina-integrator/site" "${cwd}/dist/${dirName}/${version}/ballerina-integrator" 
...
########

     mkdocs build
     cd ..         
     mv -f "${cwd}/${dirName}/site" "${cwd}/dist/${dirName}/${version}/"    
    fi
  fi
 done
 
}


if [ "$BUILD_ALL" == "true" ]; then #check trigger manually or automatically

   echo build triggered manually
   
#obtain branch names in a git repo       
 for BRANCH in `git branch -a | grep remotes/origin/*` ;
  do   
   git checkout versions
   GIT_BRANCH_NAME="$(cut -d'/' -f3 <<<"$BRANCH")"  
     
#obtain branch names from versions.json and check with the git branches      
   for version in $(cat en/docs/assets/versions.json | jq -r '.all' | jq -r 'keys[]'); do     
    if [ "$GIT_BRANCH_NAME" == "${version}" ]; then 
      build "${version}"
    fi   
   done   
  done 
#these branches must build in each trigger  
      build "versions"
      build "master"
   
else

  echo build triggered automatically 
#obtain committed branch names in a git repo   
  GIT_BRANCH_NAME="$(cut -d'/' -f2 <<<"$GIT_BRANCH")"  
  git checkout versions
    
#obtain branch names from versions.json and check with the git branches            
  for version in $(cat en/docs/assets/versions.json | jq -r '.all' | jq -r 'keys[]'); do
   if [ "$GIT_BRANCH_NAME" == "${version}" ]; then   
   	 build "${version}"   
      
    # else
     # build "$(cat en/docs/assets/versions.json | jq -r '.current')"
   fi      
  done
    
#these branches must build in each trigger     
    build "versions"
    build "master"
     
fi

Config descriptions for the following toml sections:

• [[custom_transport.listener]]
• [[custom_transport.sender]]

This issue is to move the initial drafts of the TRANSPORT docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/transports
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

This issue is to move the initial drafts of the CONNECTORS docs for the Micro Integrator docs.
** This issue is only for the content that was in the EI 650 space [1]. The remaining connector docs will be tracked through [4]

Move all the related content to github [2].
Update the yaml with the navigation structure [3].

[1] https://docs.wso2.com/display/EI650/Working+with+Connectors
[2] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/transports
[3] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml
[4] #87

This issue is to move the initial drafts of the ERROR HANDLING docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/references/error_handling.md
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

Description:
Adding documentation on the architecture of the Streaming Integration profile.

Suggested Labels:
Streaming-Integration docs

Affected Product Version:
EI 7.0.0

Link
https://github.com/wso2/docs-ei/blob/master/en/streaming-integrator/docs/overview/architecture.md

Config descriptions for the following toml sections:

• [[transport.jms.sender]]
• [[transport.jms.listener]]

For example, under Quick Start Guide, we have the term appearing twice under this section and that looks like a bug. Same story with Concepts.

This issue is to move the initial drafts of the TEMPLATES docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/templates
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

Identify initial list of samples.

This issue is to move the initial drafts of the Message Stores and Processors docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/message_stores_processors
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

We need a dropdown to pick between the different integrators:

• Micro Integrator
• Ballerina Integrator
• Streaming Integrator

The docs on keystores [1] rewritten [2].
See preview on netlify [3].

[1] https://docs.wso2.com/display/ADMIN44x/Using+Asymmetric+Encryption
[2]

• https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/setup/security/creating_keystores.md
• https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/setup/security/importing_ssl_certificate.md
• https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/setup/security/configuring_keystores.md

[3] https://wso2docs-configurationcatalog-3.netlify.com/setup/security/creating_keystores/

Add the best practices into GitHub and edit the .yaml file to get the navigation to work.

@samgnaniah commented on Wed Jun 05 2019

Need to do formatting changes in the QSG so that rendering issues are fixed.

This issue is to move the initial drafts of the INBOUND ENDPOINT docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/inbound_endpoints
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

The content on password encryption [1], rewritten in [2].
Preview on netlify[3].

[1] https://docs.wso2.com/display/ADMIN44x/Securing+Passwords+in+Configuration+Files
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/setup/security/encrypting_plain_text.md

[3] https://wso2docs-configurationcatalog-3.netlify.com/setup/security/encrypting_plain_text/

Improve the READMEfor the docs-ei repo. Some suggestions for improvement are:

• Way to build and run.
• Links to License and Contribution etc.

Add the initial set of mediators. Convert them from confluence docs using the script and then upload them. Also fix the navigation via the .yaml file.

Description:
As explained in [1] there could be occurrences where characters such as (";", "/", "?", ":", "@", "=" and "&" ) should be able to be passed as reserved characters instead of encoding. In order to do this, we need to add '+' as a prefix when adding {query.param} to a uri-template.

Affected Product Version:
EI-6.1.1

Steps to reproduce:

1. Enable wire logs in integrator profile.
2. Create and deploy the API given in [1].
3. Invoke API as given in [1].
4. In debug logs, it could be noted that the request sent out from EI has encoded the reserved character. ("GET ?symbol=some%3Avalue HTTP/1.1[\r][\n]")
5. Update the endpoint of the API as below.

 <endpoint>
       <http method="GET" uri-template="http://abc.com?symbol={+query.param.type}"/>
  </endpoint>

6. Invoke the API again and it could be noted that the reserved character is not encoded.
   (GET ?symbol=some:value )

Related Issues:
https://wso2.org/jira/browse/ESBJAVA-3435

[1] https://wso2.org/jira/browse/ESBJAVA-3435

@samgnaniah commented on Wed Jun 05 2019

Come up with an initial list of samples. This involves:

• Analyzing samples by others in the industry
• Reanalyzing existing samples.
• Sharing findings and discussing with product team leads on the way forward.

This epic is to track the documentation related to Data Services for the Micro Integrator.
This is the continuation of [1].

[1] #73

Remaining work for the QSG:

• Update the project file attachments for the QSG [1]
• Validate (with team) the QSG's applicability to EI 7
• Text formatting and Copy editing

[1] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/quick-start-guide/quick-start-guide.md

Complete the descriptions for the [mediation] toml configs.

@samgnaniah commented on Wed Jun 05 2019

Come up with an initial list of guides. This involves:

• Analyzing guides by others in the industry
• Reanalyzing existing guides/tutorials.
• Sharing findings and discussing with product team leads on the way forward.

The clustering instructions for EI650 [1] rewritten for EI700 [2]. New toml-based configs applied.

[1] https://docs.wso2.com/display/EI650/Clustering+the+ESB+Profile
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/setup/deployment/deploying_wso2_ei.md

related issues:

• diagram update: #332
• hazelcast for deployment: #337

Config descriptions for the parameters in the following toml config sections:

• [[transport.rabbitmq.listener]]
• [[transport.rabbitmq.sender]]

Description:
Add content to the Overview page of Streaming Integration Docunmentation

Suggested Labels:
Streaming Integration

Affected Product Version:
EI 7.0.0

Link
https://github.com/wso2/docs-ei/blob/master/en/streaming-integrator/docs/overview/overview.md

The content on symmetric encryption [1] rewritten for [2].
Please see preview on netlify[3].

[1] https://docs.wso2.com/display/ADMIN44x/Using+Symmetric+Encryption
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/setup/security/single_key_encryption.md

[3] https://wso2docs-configurationcatalog-3.netlify.com/setup/security/single_key_encryption/

This issue is to move the initial drafts of the ENDPOINT docs for the Micro Integrator docs.

• Move all the related content to github [1].
• Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/endpoints
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

This issue is to move the existing content on Message Builders and Formatters [1].

[1] https://docs.wso2.com/display/EI650/Working+with+Message+Builders+and+Formatters

This involves competitor analysis and presenting the findings to the team so that they can make an informed decision and come up with a list.

Use the following PRs to update the styles and templates in docs-ei to reflect latest UX changes:

wso2/docs-is#45
wso2/docs-is#49

This issue is to move the initial drafts of the SYNAPSE HANDLERS docs for the Micro Integrator docs.

Move all the related content to github [1].
Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/references/synapse_handlers
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

Description for config parameters under the following toml section:

• [transport.mqtt]

Config descriptions for the [transport.http] toml section.

This issue is to clean up the formatting errors that exist in the pages of the INSTALL AND SETUP section [1]. This is because the html to md file conversion has created formatting errors, which makes some docs incomprehensible.

Once this task is completed, we can start a developer review of the content and start refining the content.

Estimated Time: 3 hours.

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/setup

This issue is for the initial draft docs and the navigation structure of the Install and Setup section in the Micro Integrator docs.

The following [1] includes all the topics that should be under the 'Install and Setup' section in for the Micro Integrator docs. The yaml [2] is updated with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/setup
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

Update the mkdocs.yaml file to include all the mediators and structure the properly.

This involves getting the set of configurations from the template repo and adding it into the docs-ei repo.

This issue is to get started on the 'Use Cases' section [1] of the Micro Integrator docs.

• Move all the related content (from the previous doc spaces) to github.
• Organize the content under 'Examples', 'Guides', and 'Tasks'. This content was previously dispersed across the doc space.
• Update the yaml with the navigation structure [2].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/use-cases
[2] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

This issue is to carry out a initial review of the topics (not content details) and pages that we have added related to 'INSTALLATION AND SETUP' [1]. Preview on [2].

• Identify irrelevant topics
• New topics that should be added
• Navigation and structure of topics

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/setup
[2] https://wso2docs-configurationcatalog-3.netlify.com/setup/deployment/deploying_wso2_ei/

This issue is to get started on the 'Administration and Observability' section [1] of the Micro Integrator docs.

• Move all the related content to github. This content is taken from the EI650 doc space [2][3] and the Admin Guide [4].
• Update the yaml with the navigation structure [5].

[1] https://github.com/wso2/docs-ei/tree/master/en/micro-integrator/docs/administer-and-observe
[2] https://docs.wso2.com/display/EI650/Product+Administration
[3] https://docs.wso2.com/display/EI650/WSO2+Micro+Integrator
[4] https://docs.wso2.com/display/ADMIN44x/Monitoring
[5] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/mkdocs.yml

This issue is to track the connector docs that should be brought into the ei git repo. The Connector-related docs that were in EI650 have been added. However, the content in the ESB Connectors page [1] and Connectors Git Docs[2] are still not added.

This issue is the continuation of [3].

[1] https://docs.wso2.com/display/EI650/Working+with+Connectors
[2] https://github.com/wso2-extensions?utf8=%E2%9C%93&q=esb&type=&language=
[3] #65

Add in the remaining content for the config catalog into GitHub.

** With this issue, we have committed the latest changes files and content of the config catalog to the ei doc repo [1].

Remaining work: Complete content based on new changes and new descriptions.

[1] https://github.com/wso2/docs-ei/blob/master/en/micro-integrator/docs/references/ei_config_catalog.md