-
Notifications
You must be signed in to change notification settings - Fork 326
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2,725 changed files
with
242,563 additions
and
15,003 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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: | | ||
|
@@ -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 | ||
|
@@ -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 | ||
|
@@ -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' }} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
0.0.265 | ||
0.0.416 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
5 changes: 5 additions & 0 deletions
5
en/asgardeo/docs/apis/organization-apis/api-resource-management-rest-api.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
5 changes: 5 additions & 0 deletions
5
en/asgardeo/docs/apis/organization-apis/org-association-rest-api.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
5 changes: 5 additions & 0 deletions
5
en/asgardeo/docs/apis/organization-apis/organization-user-share.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
Oops, something went wrong.