Giter Club home page Giter Club logo

docs-ei's Introduction

WSO2 Enterprise Integrator Documentation

This is the documentation for the upcoming release of the WSO2 Enterprise Integrator 7 family. Please note that this documentation is work in progress.

To see the latest released documentation for the WSO2 Enterprise Integrator 7 family, go to: https://ei.docs.wso2.com/en/latest/

Contributing to WSO2 EI documentation

As an open source project, WSO2 EI welcomes contributions from the community. To start contributing, read these contribution guidelines for information on how you should go about contributing to our project.

  1. Accept the Contributor License Agreement (CLA)

    You need to Accept the Contributor License Agreement (CLA) when prompted by a GitHub email notification after sending your first Pull Request (PR). Subsequent PRs will not require CLA acceptance.

    If the CLA gets changed for some (unlikely) reason, you will be presented with the new CLA text after sending your first PR after the change.

  2. Fork this repository, make your changes, and send in a pull request. Make sure you are contributing to the correct branch (for example, if your change is relevant to WSO2 EI 7.0.0 documentation, you should commit your changes to the 7.0.0 branch).

Check the issue tracker for open issues that interest you. We look forward to receiving your contributions.

Building the documentation locally

1. Install Python.

If you are using MacOS, you probably already have a version of Python installed on your machine. You can verify this by running the following command.

python --version Python 2.7.2

If your version of Python is Python 2.x.x, you also need to install Python3. This is because the PDF plugin only supports Python3. Follow the instructions on this guide to install Python3 properly.

Once you are done, you will have two versions of Python on your machine; a version of python2 and a version of python3.

2. Install Pip.

Pip is most likely installed by default. However, you may need to upgrade pip to the latest version:

pip install --upgrade pip

If pip is not already installed on your machine, download get-pip.py to install pip for the first time. Then run the following command to install it:

python get-pip.py

3. Install pip packages

pip install mkdocs

pip install mkdocs-material

pip install markdown-include

pip install pymdown-extensions

4. Run mkdocs

Clone this GitHub repository.

Navigate to the branch you want and the directory you want. For example, cd docs-ei/en/micro-integrator/ in the 7.0.0 branch. Then run the following command:

mkdocs serve --dirtyreload

Open the URL that is generated in a new browser window to view the sample site.

docs-ei's People

Contributors

nilminiwso2 avatar samgnaniah avatar rukshiw avatar dilini-muthumala avatar nirothipan avatar dmadhuranga avatar sajithshn avatar kasunaratthanage avatar charukak avatar rosensilva avatar sybernix avatar sdkottegoda avatar vathsan avatar isudana avatar drifftr avatar gdlmadushanka avatar arunans23 avatar isuruuy429 avatar abeykoon avatar sachithkay avatar dilee avatar dnwick avatar chanikag avatar dakshika avatar sajithaliyanage avatar malakaganga avatar prabushi avatar nandika avatar erangatl avatar sameeragunarathne avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.