Skip to content

Commit

Permalink
Resolve merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
ThaminduDilshan committed Mar 1, 2025
2 parents e947279 + 6e1773d commit 72c0a0e
Show file tree
Hide file tree
Showing 2,725 changed files with 242,563 additions and 15,013 deletions.
32 changes: 31 additions & 1 deletion .github/workflows/release-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
python-version: '3.12'

- name: Install dependencies
run: |
Expand Down Expand Up @@ -90,22 +90,35 @@ jobs:

- name: Build MkDocs Documentation
run: |
unset ENABLE_HOOKS
cd en/asgardeo
mkdocs build
cd ../../
- name: Conditionally build MkDocs Documentation
run: |
export ENABLE_HOOKS=true
cd en/asgardeo
mkdocs build --site-dir prod-build
cd ../../
- name: Zip the Documentation
run: |
mkdir -p out/asgardeo/docs
mkdir -p out-prod/asgardeo/docs
cp -r ./en/asgardeo/site/* out/asgardeo/docs/
cp -r ./en/asgardeo/prod-build/* out-prod/asgardeo/docs/
zip -r asgardeo-docs-${{ env.NEW_VERSION }}.zip ./out
zip -r asgardeo-docs-${{ env.NEW_VERSION }}-prod.zip ./out-prod
- name: Create git tag
run: |
git config user.name $GIT_USERNAME
git config user.email $GIT_USER_EMAIL
git tag "v${{ env.NEW_VERSION }}"
git tag "v${{ env.NEW_VERSION }}-prod"
git push "https://$GIT_USERNAME:[email protected]/${{ github.repository }}" "v${{ env.NEW_VERSION }}"
git push "https://$GIT_USERNAME:[email protected]/${{ github.repository }}" "v${{ env.NEW_VERSION }}-prod"
- name: Create Release
id: create_release
Expand All @@ -115,6 +128,15 @@ jobs:
release_name: Asgardeo Docs - v${{ env.NEW_VERSION }}
draft: false
prerelease: ${{ env.IS_HOTFIX == 'true' }}

- name: Create prod release
id: create_prod_release
uses: actions/create-release@v1
with:
tag_name: v${{ env.NEW_VERSION }}-prod
release_name: Asgardeo Docs - v${{ env.NEW_VERSION }}-prod
draft: false
prerelease: ${{ env.IS_HOTFIX == 'true' }}

- name: Upload Release Asset
uses: actions/upload-release-asset@v1
Expand All @@ -123,6 +145,14 @@ jobs:
asset_path: ./asgardeo-docs-${{ env.NEW_VERSION }}.zip
asset_name: asgardeo-docs-${{ env.NEW_VERSION }}.zip
asset_content_type: application/zip

- name: Upload Prod Release Asset
uses: actions/upload-release-asset@v1
with:
upload_url: ${{ steps.create_prod_release.outputs.upload_url }}
asset_path: ./asgardeo-docs-${{ env.NEW_VERSION }}-prod.zip
asset_name: asgardeo-docs-${{ env.NEW_VERSION }}-prod.zip
asset_content_type: application/zip

- name: Commit and push new version
if: ${{ env.IS_HOTFIX == 'false' }}
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ node_modules
en/identity-server/*/site
en/asgardeo/site

# Python virtula environment
# Python virtual environment
.venv
en/asgardeo/__pycache__/
**/__pycache__/
69 changes: 69 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Contributing to WSO2 Identity Server / Asgardeo Documentation

We would really appreciate your contributions to WSO2 Identity Server / Asgardeo Docs to help make it even better than it is today!
As a contributor, here are the guidelines we would like you to follow:

- [Adding Quickstart guides](#adding-quickstart-guides)
- [Adding Complete guides](#adding-complete-guides)

## Adding Quickstart guides

Please refer added sample [en/asgardeo/docs/quick-starts/react.md](en/asgardeo/docs/quick-starts/react.md).

#### Example

Add below frontmatter yaml block to your new file along with quick start steps with H2 headings. Which will auto convert to steps in the page.

```markdown
---
template: templates/quick-start.html
heading: <!-- Page heading -->
description: <!-- Page sub heading description -->
what_you_will_learn: <!-- List of text (HTML supported) -->
prerequisites: <!-- List of text (HTML supported) -->
source_code: <a href="link" target="_blank" class="github-icon"><!-- Sample Name --></a>
whats_next: <!-- List of text (HTML supported) -->
---

## Step 1

Some Content

## Step 2

Some Content
```

## Adding Complete guides

Please refer added sample [en/asgardeo/docs/complete-guides/react](en/asgardeo/docs/complete-guides/react).

Need below front-matter config in the doc file.

E.g.,
```yaml
---
template: templates/complete-guide.html
heading: Introduction
read_time: 2 mins
---
```

And in define pages in `mkdocs.yaml` config file.

E.g.,
```yaml
---
nav_icons:
React: fontawesome/brands/react

nav:
- Technology Guides:
- React: complete-guides/react/introduction.md
- React|hide_nav:
- Introduction: complete-guides/react/introduction.md
- Prerequisite: complete-guides/react/prerequisite.md
...
- Next Steps: complete-guides/react/next-steps.md
---
```
67 changes: 37 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,17 @@
* [Run the project locally](#run-the-project-locally)
+ [With Python Virtual Environments](#with-python-virtual-environments)
+ [With Devcontainers](#with-devcontainers)
* [Contribute to documentation](#contribute-to-documentation)
* [Survey On Open Source Community Communication](#survey-on-open-source-community-communication)
* [License](#license)

# WSO2 Identity Server and Asgardeo Documentation

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

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

## Contribute to documentation

Before you contribute, read the following guidelines to understand how you can start contributing:

1. Accept the contributor license agreement (CLA)

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.

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.

2. Fork this repository, make your changes, and send in a pull request.

We look forward to your contributions.

## Run the project locally

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

Choose one of the following methods depending on your preference.

### With Devcontainers

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:

- VS Code
- Docker installed on your system
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VS Code

Once you have these installed, you can open the repository in VS Code and follow these steps:

- Press F1 and select the Remote-Containers: Open Folder in Container... command.
- Select the repository folder and wait for the container to build and start.
- You can now edit, run, debug, and test your code inside the container.

For more information on how to use VS Code dev containers, please refer to the official documentation: https://code.visualstudio.com/docs/remote/containers

### With Python Virtual Environments

You can run the Asgardeo docs and WSO2 Identity Server docs locally using Python virtual environments as well.
Expand Down Expand Up @@ -130,6 +107,36 @@ mkdocs serve
> python3 -m mkdocs serve
> ```
### With Devcontainers
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:
- VS Code
- Docker installed on your system
- [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VS Code
Once you have these installed, you can open the repository in VS Code and follow these steps:
- Press F1 and select the Remote-Containers: Open Folder in Container... command.
- Select the repository folder and wait for the container to build and start.
- You can now edit, run, debug, and test your code inside the container.
For more information on how to use VS Code dev containers, please refer to the official documentation: https://code.visualstudio.com/docs/remote/containers
## Contribute to documentation
Before you contribute, read the following guidelines to understand how you can start contributing:
1. Accept the contributor license agreement (CLA)
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.
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.
2. Fork this repository, make your changes, and send in a pull request.
We look forward to your contributions.
## Survey On Open Source Community Communication
WSO2 wants to learn more about our open source software (OSS) community and your communication preferences to serve you better.
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.0.265
0.0.416
5 changes: 5 additions & 0 deletions en/asgardeo/docs/apis/notification-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
template: templates/redoc.html
---

<redoc spec-url="{{base_path}}/apis/restapis/notification-templates.yml" theme='{{redoc_theme}}'></redoc>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
template: templates/redoc.html
---

<redoc spec-url="{{base_path}}/apis/organization-apis/restapis/api-resources.yaml" theme='{{redoc_theme}}'></redoc>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
template: templates/redoc.html
---

<redoc spec-url="{{base_path}}/apis/organization-apis/restapis/association-management-by-admin.yaml" theme='{{redoc_theme}}'></redoc>
5 changes: 5 additions & 0 deletions en/asgardeo/docs/apis/organization-apis/org-user-store.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
template: templates/redoc.html
---

<redoc spec-url="{{base_path}}/apis/organization-apis/restapis/org-user-store.yaml" theme='{{redoc_theme}}'></redoc>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
template: templates/redoc.html
---

<redoc spec-url="{{base_path}}/apis/organization-apis/restapis/organization-user-share.yaml" theme='{{redoc_theme}}'></redoc>
Loading

0 comments on commit 72c0a0e

Please sign in to comment.