Skip to content

Latest commit

 

History

History
121 lines (63 loc) · 4.94 KB

README.md

File metadata and controls

121 lines (63 loc) · 4.94 KB
Raw

WSO2 API Microgateway Documentation

BUILD STATUS stackoverflow slack

This repository contains documentation source for the WSO2 API Microgateway (3.2.0 onwards). Please note that this documentation is constantaly being improved.

To see the latest documentation for the WSO2 API Microgateway, go to: https://mg.docs.wso2.com/en/latest/

To find the documentation of version prior to 3.2.0 visit https://docs.wso2.com/display/MG310/

Contributing to WSO2 API Microgateway documentation

As an open source project, WSO2 API Microgateway 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 (PR). Make sure you are contributing to the correct branch (for example, if your change is relevant to WSO2 API Microgateway 3.2.0 documentation, you should commit your changes to the master branch).

  3. Send multiple pull requests to all the relevant branches.

    If your change is relevant to the latest API Microgateway release, please send your change to the respective latest API Microgateway release branch and the master branch, which is the upcoming API Microgateway release documentation branch, as well.

    For example, if the latest API Microgateway release is 3.2.0, and if your change is relevant to API Microgateway 3.3.0 and 3.2.0, send PRs to the 3.2.0, and the master branches.

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

Run the project locally

Step 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 in 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.

Step 2 - Install Pip

!!! info 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`

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

$ pip install --upgrade pip

Step 3 - Install the pip packages

  1. Navigate to the / folder.

    $ cd docs-apim/en

  2. Install the required pip packages.

    This will install MkDocs and the required theme, extensions, and plugins.

    • If you are using Python2, use the following command:

      pip install -r requirements.txt

    • If you are using Python3, use the following command:

      pip3 install -r requirements.txt

Step 4 - Run MkDocs

Follow the steps below to clone the API-M documentation GitHub repository and to run the site on your local server.

  1. Fork the following GitHub repository.

    https://github.com/wso2/docs-mg.git

  2. Navigate to the place where you want to clone the repo.

    Git clone the forked repository.

    $ git clone https://github.com/[git-username]/docs-mg.git

  3. Navigate to the folder containing the repo that you cloned in step 4.1 on a terminal window.

    For example:

    $ cd docs-mg/<Language-folder>/

    $ cd docs-mg/en/

  4. Run the following command to start the server and view the site on your local server.

    $ mkdocs serve

    NOTE:

    If you are making changes and want to see them on the fly, running the server with mkdocs serve --dirtyreload option will make the server load only the changed items and display the changes faster.

  5. Open the following URL on a new browser window to view the API-M documentation site locally.

    http://localhost:8000/getting-started/overview/

License

Licenses this source under the Apache License, Version 2.0 (LICENSE), You may not use this file except in compliance with the License.