libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions
keycloak-scim/docs/documentation
History
Martin Bartoš 1fb83bb165
Release notes and Migration guide for Hostname v2 (#28621) 
Closes #27730

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Václav Muzikář <vmuzikar@redhat.com>
Co-authored-by: Peter Zaoral <pzaoral@redhat.com>
2024-04-17 09:29:59 +02:00
..
aggregation Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
api_documentation Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
authorization_services Clean up feature IDs in the docs (#27418) 2024-03-06 12:32:06 +01:00
dist Run tests for the moved documentation (#19278) 2023-03-28 12:35:27 +02:00
header-maven-plugin Update Maven dependency versions for docs 2024-02-01 13:42:25 +01:00
internal_resources Update docs/documentation/internal_resources/contributing.adoc 2023-06-02 07:58:59 -03:00
release_notes Release notes and Migration guide for Hostname v2 (#28621) 2024-04-17 09:29:59 +02:00
securing_apps Documentation for changes related to 'You are already logged in' scen… (#28595) 2024-04-11 08:18:41 +02:00
server_admin Limit the concurrency of password hashing to the number of CPU cores available 2024-04-15 15:05:09 +02:00
server_development doc: add a note about lack of other JAX-RS support (#28048) 2024-03-21 16:59:22 +01:00
tests docs: Support management port for health and metrics (#28213) 2024-04-09 14:33:30 +02:00
topics/templates Simplify Upgrade Guide structure 2024-03-11 16:22:46 +01:00
upgrading Release notes and Migration guide for Hostname v2 (#28621) 2024-04-17 09:29:59 +02:00
.asciidoctorconfig Remove latest vs. archive document header (#20103) 2023-05-03 09:16:34 +00:00
.gitattributes Moving docs to new folder 2023-03-20 09:07:58 +01:00
.gitignore Cache Node.js installation and PNPM store 2023-10-30 07:50:06 -04:00
.vale.ini Moving docs to new folder 2023-03-20 09:07:58 +01:00
build-auto.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
get-version.sh Moving docs to new folder 2023-03-20 09:07:58 +01:00
License.html Moving docs to new folder 2023-03-20 09:07:58 +01:00
pom.xml Update Maven dependency versions for docs 2024-02-01 13:42:25 +01:00
README.md Changed references to Jira issues to Github issues 2023-05-09 08:54:25 +02:00

README.md

Keycloak Documentation

Open Source Identity and Access Management for modern Applications and Services.

For more information about Keycloak visit the Keycloak homepage and Keycloak blog.

Contributing to Keycloak Documentation

See our Contributor's Guide. The directory also includes a set of templates and other resources to help you get started.

If you want to file a bug report or tell us about any other issue with this documentation, you are invited to please use our issue tracker.

Building Keycloak Documentation

Ensure that you have Maven installed.

First, clone the Keycloak repository:

git clone https://github.com/keycloak/keycloak.git
cd keycloak/docs/documentation

If you are using Windows, you need to run the following command with administrator privilege because this project uses symbolic links:

git clone -c core.symlinks=true https://github.com/keycloak/keycloak.git

To build Keycloak Documentation run:

mvn clean install -am -pl docs/documentation/dist -Pdocumentation

Or to build a specific guide run:

mvn clean install -pl docs/documentation/GUIDE_DIR -Pdocumentation

By default, an archive version of the documentation is built. To build the latest build run:

mvn clean install ... -Platest,documentation

You can then view the documentation by opening docs/documentation/GUIDE_DIR/target/generated-docs/index.html.

License