From 16db810b03b0318779e321dde9ac3ae0cdc1dd86 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira da Silva Date: Wed, 3 Nov 2021 11:40:15 -0300 Subject: [PATCH] [KEYCLOAK-19754] - Update documentation files to remove problematic language in the main repository --- CONTRIBUTING.md | 8 ++++---- GOVERNANCE.md | 4 ++-- docs/building.md | 2 +- docs/pull_request_template.md | 2 +- docs/tests-db.md | 2 +- docs/tests-oidc-conformance.md | 2 +- docs/updating-server-config.md | 4 ++-- examples/kerberos/README.md | 4 ++-- examples/providers/authenticator/README.md | 2 +- .../org/keycloak/vault/FilesPlainTextVaultProvider.java | 2 +- testsuite/integration-arquillian/HOW-TO-RUN.md | 2 +- .../testsuite/arquillian/CrossDCTestEnricher.java | 2 +- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8136e52286..e2c474a576 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Here's a quick checklist for a good PR, more details below: 2. A JIRA with a good description associated with the PR 3. One feature/change per PR 4. One commit per PR -5. PR rebased on master (`git rebase`, not `git pull`) +5. PR rebased on main (`git rebase`, not `git pull`) 5. Commit message is prefixed by JIRA number 6. No changes to code not directly related to your PR 7. Includes functional/integration test @@ -45,7 +45,7 @@ Discussions should first and foremost be done through [GitHub Discussions](https The [Keycloak Dev Mailing List](https://groups.google.com/forum/#!forum/keycloak-dev) can be used to notify the community on your new discussion, and can also be used for more low-level implementation discussions. -For very large proposals it can be inefficient to capture all the information in the GitHub Discussion. In this cases a separate design proposal can be sent to the [Keycloak Community repository](https://github.com/keycloak/keycloak-community/tree/master/design), and linked to from the GitHub Discussion. +For very large proposals it can be inefficient to capture all the information in the GitHub Discussion. In this cases a separate design proposal can be sent to the [Keycloak Community repository](https://github.com/keycloak/keycloak-community/tree/main/design), and linked to from the GitHub Discussion. ### Create an issue in Keycloak JIRA @@ -81,10 +81,10 @@ In the description of your PR include a link to the PR to [Keycloak Documentatio ### Submitting your PR -When preparing your PR make sure you have a single commit and your branch is rebased on the master branch from the +When preparing your PR make sure you have a single commit and your branch is rebased on the main branch from the project repository. -This means use the `git rebase` command and not `git pull` when integrating changes from master to your branch. See +This means use the `git rebase` command and not `git pull` when integrating changes from main to your branch. See [Git Documentation](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) for more details. We require that you squash to a single commit. You can do this with the `git rebase -i HEAD~X` command where X diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 3dccf18401..370dd30345 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -98,9 +98,9 @@ For larger changes all maintainers and contributors should have a chance of revi For new features we highly recommend always opening a discussion in GitHub Discussions early. -For very large proposals it can be inefficient to capture all the information in the GitHub Discussion. In this cases a separate design proposal can be sent to the [Keycloak Community repository](https://github.com/keycloak/keycloak-community/tree/master/design), and linked to from the GitHub Discussion. +For very large proposals it can be inefficient to capture all the information in the GitHub Discussion. In this cases a separate design proposal can be sent to the [Keycloak Community repository](https://github.com/keycloak/keycloak-community/tree/main/design), and linked to from the GitHub Discussion. The contributor can decide to send a pull request prior to discussions. However, the change will not be accepted until it has been discussed through [GitHub Discussions](https://github.com/keycloak/keycloak/discussions/categories/ideas). If there are any objections to the change they can in most cases be resolved through discussions in [GitHub Discussions](https://github.com/keycloak/keycloak/discussions/categories/ideas), or -in the pull request. If a resolution can not be made it can be accepted if at least 2/3 of maintainers approve the change. \ No newline at end of file +in the pull request. If a resolution can not be made it can be accepted if at least 2/3 of maintainers approve the change. diff --git a/docs/building.md b/docs/building.md index 1a6e34ff5a..5b635927fa 100644 --- a/docs/building.md +++ b/docs/building.md @@ -75,7 +75,7 @@ To stop the server press `Ctrl + C`. ## Working with the codebase We don't currently enforce a code style in Keycloak, but a good reference is the code style used by WildFly. This can be -retrieved from [Wildfly ide-configs](https://github.com/wildfly/wildfly-core/tree/master/ide-configs).To import formatting +retrieved from [Wildfly ide-configs](https://github.com/wildfly/wildfly-core/tree/main/ide-configs).To import formatting rules, see following [instructions](http://community.jboss.org/wiki/ImportFormattingRules). If your changes require updates to the database read [Updating Database Schema](updating-database-schema.md). diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 6c0cf1fa17..b8a61150b0 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,3 +1,3 @@ diff --git a/docs/tests-db.md b/docs/tests-db.md index 4728494590..68f18e54b5 100644 --- a/docs/tests-db.md +++ b/docs/tests-db.md @@ -82,7 +82,7 @@ first need to download the JDBC driver and install it to your local maven repo mvn install:install-file -DgroupId=com.oracle -DartifactId=ojdbc7 -Dversion=12.1.0 -Dpackaging=jar -Dfile=ojdbc7.jar -DgeneratePom=true Then build the Docker image per instructions at -https://github.com/oracle/docker-images/tree/master/OracleDatabase. The last +https://github.com/oracle/docker-images/tree/main/OracleDatabase. The last step is running which might require updating the `jdbc.mvn.groupId`, `jdbc.mvn.artifactId`, and `jdbc.mvn.version` according to the parameters you used in the command above, and `docker.database.image` if you used a different diff --git a/docs/tests-oidc-conformance.md b/docs/tests-oidc-conformance.md index 720329f5f0..a0eb406f54 100644 --- a/docs/tests-oidc-conformance.md +++ b/docs/tests-oidc-conformance.md @@ -93,7 +93,7 @@ Update the openshift cartridge with latest Keycloak --------------------------------------------------- Once some issue is fixed on Keycloak side, you may want to doublecheck if test on OIDC conformance side is passing. Hence you may want to test with JARs from latest -Keycloak master instead of the "official release" Keycloak JARs from cartridge. +Keycloak main instead of the "official release" Keycloak JARs from cartridge. Openshift allows to connect with SSH and restart the cartridge. So you may use something like this on your laptop (example with the fix in module keycloak-services ). diff --git a/docs/updating-server-config.md b/docs/updating-server-config.md index 37f5af55e0..d17ecf0783 100644 --- a/docs/updating-server-config.md +++ b/docs/updating-server-config.md @@ -2,7 +2,7 @@ If you need to make a change to the default keycloak-subsystem configuration that is packaged with our distributions, you will need to edit this file: -https://github.com/keycloak/keycloak/blob/master/wildfly/server-subsystem/src/main/config/default-server-subsys-config.properties +https://github.com/keycloak/keycloak/blob/main/wildfly/server-subsystem/src/main/config/default-server-subsys-config.properties This file contains a single multi-line property containing the subsystem xml declaration. Maven filtering is used to read this property and @@ -10,7 +10,7 @@ inject it everywhere it needs to go. Editing this file will also take care of propagating it to the distributions like server-dist and demo-dist. Also, you need to create CLI commands for each change by editing this file: -https://github.com/keycloak/keycloak/blob/master/wildfly/server-subsystem/src/main/resources/cli/default-keycloak-subsys-config.cli +https://github.com/keycloak/keycloak/blob/main/wildfly/server-subsystem/src/main/resources/cli/default-keycloak-subsys-config.cli This CLI snippet is used in the scripts required by the overlay distribution. diff --git a/examples/kerberos/README.md b/examples/kerberos/README.md index 2333677b39..e501f467a0 100644 --- a/examples/kerberos/README.md +++ b/examples/kerberos/README.md @@ -56,7 +56,7 @@ mvn exec:java -Pkerberos This will also automatically import the LDIF from `kerberos-example-users.ldif` of kerberos example into the LDAP server. Replace with your own LDIF file if you want different users. -A bit more details about embedded Kerberos server in [Executing Tests](https://github.com/keycloak/keycloak/blob/master/docs/tests.md#kerberos-server). +A bit more details about embedded Kerberos server in [Executing Tests](https://github.com/keycloak/keycloak/blob/main/docs/tests.md#kerberos-server). **WARNING**: ApacheDS kerberos server shouldn't be used in production. @@ -64,7 +64,7 @@ A bit more details about embedded Kerberos server in [Executing Tests](https://g **7)** Configure browser (Firefox, Chrome or other) and enable SPNEGO authentication and credential delegation for `localhost` . Consult the documentation of your browser and OS on how to do it. For example in Firefox it can be done by adding `localhost` to both `network.negotiate-auth.trusted-uris` and `network.negotiate-auth.delegation-uris` and switch `network.negotiate-auth.allow-non-fqdn` to `true`. -A bit more details in [Executing Tests](https://github.com/keycloak/keycloak/blob/master/docs/tests.md#kerberos-server). +A bit more details in [Executing Tests](https://github.com/keycloak/keycloak/blob/main/docs/tests.md#kerberos-server). **8)** Test the example. Obtain kerberos ticket by running command from Terminal / CMD: diff --git a/examples/providers/authenticator/README.md b/examples/providers/authenticator/README.md index c86cd8837f..2129593928 100755 --- a/examples/providers/authenticator/README.md +++ b/examples/providers/authenticator/README.md @@ -2,7 +2,7 @@ Example Custom Authenticator =================================================== 1. First, Keycloak must be running. See [Getting Started](https://github.com/keycloak/keycloak#getting-started), or you - can build distribution from [source](https://github.com/keycloak/keycloak/blob/master/docs/building.md). + can build distribution from [source](https://github.com/keycloak/keycloak/blob/main/docs/building.md). 2. Execute the follow. This will build the example and deploy it diff --git a/services/src/main/java/org/keycloak/vault/FilesPlainTextVaultProvider.java b/services/src/main/java/org/keycloak/vault/FilesPlainTextVaultProvider.java index dc6f17f79e..33fdea5715 100644 --- a/services/src/main/java/org/keycloak/vault/FilesPlainTextVaultProvider.java +++ b/services/src/main/java/org/keycloak/vault/FilesPlainTextVaultProvider.java @@ -25,7 +25,7 @@ import java.util.Optional; * the default resolver when none is defined). Other layouts are available through different resolvers. * * See https://kubernetes.io/docs/concepts/configuration/secret/ - * See https://github.com/keycloak/keycloak-community/blob/master/design/secure-credentials-store.md#plain-text-file-per-secret-kubernetes--openshift + * See https://github.com/keycloak/keycloak-community/blob/main/design/secure-credentials-store.md#plain-text-file-per-secret-kubernetes--openshift * * @author Sebastian Łaskawiec */ diff --git a/testsuite/integration-arquillian/HOW-TO-RUN.md b/testsuite/integration-arquillian/HOW-TO-RUN.md index 23e2853b42..c2280278b3 100644 --- a/testsuite/integration-arquillian/HOW-TO-RUN.md +++ b/testsuite/integration-arquillian/HOW-TO-RUN.md @@ -1093,7 +1093,7 @@ because this is not UI testing). For debugging purposes you can override the hea -Dauth.server.host=[some_host] -Dauth.server.host2=[some_other_host] ## Hostname Tests -For changing the hostname in the hostname tests (e.g. [DefaultHostnameTest](https://github.com/keycloak/keycloak/blob/master/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/url/DefaultHostnameTest.java)), +For changing the hostname in the hostname tests (e.g. [DefaultHostnameTest](https://github.com/keycloak/keycloak/blob/main/testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/url/DefaultHostnameTest.java)), we rely on [nip.io](https://nip.io) for DNS switching, so tests will work everywhere without fiddling with `etc/hosts` locally. ### Tips & Tricks: diff --git a/testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/CrossDCTestEnricher.java b/testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/CrossDCTestEnricher.java index 4e31cef7a7..afe65a7a00 100644 --- a/testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/CrossDCTestEnricher.java +++ b/testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/CrossDCTestEnricher.java @@ -269,7 +269,7 @@ public class CrossDCTestEnricher { } /* Code to detect if underlying JVM is modular (AKA JDK 9+) taken over from Wildfly Core code base: - * https://github.com/wildfly/wildfly-core/blob/master/launcher/src/main/java/org/wildfly/core/launcher/Jvm.java#L59 + * https://github.com/wildfly/wildfly-core/blob/main/launcher/src/main/java/org/wildfly/core/launcher/Jvm.java#L59 * and turned into a function for easier reuse. */ public static boolean isModularJvm() {