wso2 / docs-is

# WSO2 Identity Platform documentation
This repository holds the source code and content for the following product documentation:
- WSO2 Identity Server - https://is.docs.wso2.com/
- WSO2 Identity Platform - https://wso2.com/asgardeo/docs/
## Table of content
- Run the project locally
 - With Python Virtual Environments
 - With Dev containers
- Install linters
- Contribute to documentation
- Survey On Open Source Community Communication
- License
## Run the project locally
Clone the repository.
 [code] 
Choose one of the following methods depending on your preference.
### With Python virtual environments
You can run the WSO2 Identity Platform docs and WSO2 Identity Server docs locally using Python virtual environments as well.
#### Prerequisites
>
> To run the project locally, it requires python & pip.
>
> - Install Python
>
> Check if you already have Python installed by running the following command.
>
> [code] 
>
> If you receive a response as shown above, `Python 3.8.0` is your default Python version.
> If you don't have `Python` installed, grab the latest release from the official downloads page.
>
> - Install pip
>
> `pip` is already installed if you use Python 3 (>=3.4) downloaded from [python.org][python-org] or if you are working in a [Virtual Environment][virtual-env-guide] created by
> [virtualenv][virtualenv] or [pyvenv][pyenv]. Just make sure to [upgrade pip][pip-upgrade-guide].
>
> [python-org]: https://www.python.org
> [virtual-env-guide]: https://packaging.python.org/tutorials/installing-packages/#creating-and-using-virtual-environments
> [virtualenv]: https://packaging.python.org/key_projects/#virtualenv
> [pyenv]: https://packaging.python.org/key_projects/#venv
> [pip-upgrade-guide]: https://pip.pypa.io/en/stable/installation/#upgrading-pip
1. Switch to the documentation you want to run locally.
 For WSO2 Identity Platform:
 [code] 
 For Identity Server:
 [code] 
2. Initialize a Python virtual environment.
 [code] 
3. Activate the created virtual environment.
 [code] 
4. Install the dependencies.
 - WSO2 Identity Server
 [code] 
 - WSO2 Identity Platform
 [code] 
5. Run the project
 [code] 
> [!NOTE]
> If you get an error that says "`mkdocs` command is not found", try the following command.
>
> [code] 
#### Test the SaaS / Self-Managed switch locally
The switch reads `page-manifest.js` from the destination site to check whether
the current page exists there. A local build generates only its own manifest;
it does not update the production site. To test both directions before deployment,
run both sites locally in separate terminals, using each site's Python environment.
Start each terminal at the repository root.
Identity Server:
 [code] 
SaaS:
 [code] 
Open `http://localhost:8000/en/7.3.0/` or
`http://localhost:8001/asgardeo/docs/` after both builds finish. Stop any existing
server on those ports before restarting with these commands. To test another IS
version, update both the IS directory and the version in the SaaS target URL.