Skip to content

Commit a53bf05

Browse files
Merge pull request #4940 from wso2/pavinduLakshan-patch-1
2 parents a53ce95 + d3561e0 commit a53bf05

File tree

1 file changed

+37
-30
lines changed

1 file changed

+37
-30
lines changed

README.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
1+
* [Run the project locally](#run-the-project-locally)
2+
+ [With Python Virtual Environments](#with-python-virtual-environments)
3+
+ [With Devcontainers](#with-devcontainers)
4+
* [Contribute to documentation](#contribute-to-documentation)
5+
* [Survey On Open Source Community Communication](#survey-on-open-source-community-communication)
6+
* [License](#license)
7+
18
# WSO2 Identity Server and Asgardeo Documentation
29

310
This is the WSO2 Identity Server and Asgardeo documentation repository. This repository is open source and we welcome your contributions!
411

512
- WSO2 Identity Server Docs: [https://is.docs.wso2.com/](https://is.docs.wso2.com/)
613
- Asgardeo Docs: [https://wso2.com/asgardeo/docs/](https://wso2.com/asgardeo/docs/)
714

8-
## Contribute to documentation
9-
10-
Before you contribute, read the following guidelines to understand how you can start contributing:
11-
12-
1. Accept the contributor license agreement (CLA)
13-
14-
You need to accept the contributor license agreement (CLA) when you are prompted via a GitHub email notification on sending your first pull request (PR). Subsequent PRs will not require CLA acceptance.
15-
16-
If the CLA changes for some (unlikely) reason, you'll have to accept the new CLA text when you send your first PR after the change.
17-
18-
2. Fork this repository, make your changes, and send in a pull request.
19-
20-
We look forward to your contributions.
21-
2215
## Run the project locally
2316

2417
Clone the repository.
@@ -29,22 +22,6 @@ git clone https://github.com/wso2/docs-is.git
2922

3023
Choose one of the following methods depending on your preference.
3124

32-
### With Devcontainers
33-
34-
This repository supports the VS Code dev containers feature, which allows you to create a consistent and isolated development environment inside a Docker container. To use this feature, you need to have the following pre requisites:
35-
36-
- VS Code
37-
- Docker installed on your system
38-
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VS Code
39-
40-
Once you have these installed, you can open the repository in VS Code and follow these steps:
41-
42-
- Press F1 and select the Remote-Containers: Open Folder in Container... command.
43-
- Select the repository folder and wait for the container to build and start.
44-
- You can now edit, run, debug, and test your code inside the container.
45-
46-
For more information on how to use VS Code dev containers, please refer to the official documentation: https://code.visualstudio.com/docs/remote/containers
47-
4825
### With Python Virtual Environments
4926

5027
You can run the Asgardeo docs and WSO2 Identity Server docs locally using Python virtual environments as well.
@@ -130,6 +107,36 @@ mkdocs serve
130107
> python3 -m mkdocs serve
131108
> ```
132109
110+
### With Devcontainers
111+
112+
This repository supports the VS Code dev containers feature, which allows you to create a consistent and isolated development environment inside a Docker container. To use this feature, you need to have the following pre requisites:
113+
114+
- VS Code
115+
- Docker installed on your system
116+
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VS Code
117+
118+
Once you have these installed, you can open the repository in VS Code and follow these steps:
119+
120+
- Press F1 and select the Remote-Containers: Open Folder in Container... command.
121+
- Select the repository folder and wait for the container to build and start.
122+
- You can now edit, run, debug, and test your code inside the container.
123+
124+
For more information on how to use VS Code dev containers, please refer to the official documentation: https://code.visualstudio.com/docs/remote/containers
125+
126+
## Contribute to documentation
127+
128+
Before you contribute, read the following guidelines to understand how you can start contributing:
129+
130+
1. Accept the contributor license agreement (CLA)
131+
132+
You need to accept the contributor license agreement (CLA) when you are prompted via a GitHub email notification on sending your first pull request (PR). Subsequent PRs will not require CLA acceptance.
133+
134+
If the CLA changes for some (unlikely) reason, you'll have to accept the new CLA text when you send your first PR after the change.
135+
136+
2. Fork this repository, make your changes, and send in a pull request.
137+
138+
We look forward to your contributions.
139+
133140
## Survey On Open Source Community Communication
134141
135142
WSO2 wants to learn more about our open source software (OSS) community and your communication preferences to serve you better.

0 commit comments

Comments
 (0)