Integrate documentation into parent build

Closes #19158
2023-03-17 10:36:02 +01:00 · 2023-03-17 10:36:02 +01:00 · acd01dedb6
commit acd01dedb6
parent f39c473866
10 changed files with 13 additions and 160 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -65,7 +65,7 @@ jobs:
        run: |
          SEP=""
          PROJECTS=""
-          for i in `find -name '*Test.java' -type f | egrep -v './(testsuite|quarkus)/' | sed 's|/src/test/java/.*||' | sort | uniq | sed 's|./||'`; do
+          for i in `find -name '*Test.java' -type f | egrep -v './(testsuite|quarkus|docs)/' | sed 's|/src/test/java/.*||' | sort | uniq | sed 's|./||'`; do
            PROJECTS="$PROJECTS$SEP$i"
            SEP=","
          done
--- a/docs/documentation/.github/ISSUE_TEMPLATE/bug.yml
+++ b/docs/documentation/.github/ISSUE_TEMPLATE/bug.yml
@ -1,40 +0,0 @@
-name: Bug Report
-description: Report a non-security sensitive bug in Keycloak
-labels: ["kind/bug", "status/triage"]
-body:
-  - type: textarea
-    attributes:
-      label: Describe the bug
-      description: Provide a clear and concise description of what the problem is.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Version
-      description: What version of Keycloak are you running?
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Expected behavior
-      description: Describe the expected behavior clearly and concisely.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Actual behavior
-      description: Describe the actual behavior clearly and concisely.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: How to Reproduce?
-      description: Provide clear and concise steps to reproduce the problem.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Anything else?
-      description: Links? References? Anything that will give us more context about the issue you are encountering!
-    validations:
-      required: false
--- a/docs/documentation/.github/ISSUE_TEMPLATE/config.yml
+++ b/docs/documentation/.github/ISSUE_TEMPLATE/config.yml
@ -1,11 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Discussions
-    url: https://github.com/keycloak/keycloak/discussions
-    about: Propose new ideas, provide feedback, or ask for help here
-  - name: User mailing list
-    url: https://groups.google.com/forum/#!forum/keycloak-user
-    about: Ask and answer questions here 
-  - name: Developer mailing list 
-    url: https://groups.google.com/forum/#!forum/keycloak-dev
-    about: Propose new features and join in design discussions here
--- a/docs/documentation/.github/ISSUE_TEMPLATE/enhancement.yml
+++ b/docs/documentation/.github/ISSUE_TEMPLATE/enhancement.yml
@ -1,31 +0,0 @@
-name: Enhancement Request
-description: Request an enhancement to an existing feature
-labels: ["kind/enhancement", "status/triage"]
-body:
-  - type: textarea
-    attributes:
-      label: Description
-      description: Describe the enhancement at a high-level.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Discussion
-      description: |
-        If there has been a discussion around the enhancement, provide a link to the discussion.
-
-        Please note that larger enhancements should be discussed through [GitHub Discussion](https://github.com/keycloak/keycloak/discussions/categories/ideas).
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Motivation
-      description: Describe why the feature should be added.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Details
-      description: More details? Implementation ideas? Anything that will give us more context about the enhancement you are proposing!
-    validations:
-      required: false
--- a/docs/documentation/.github/ISSUE_TEMPLATE/epic.yml
+++ b/docs/documentation/.github/ISSUE_TEMPLATE/epic.yml
@ -1,32 +0,0 @@
-name: Epic
-description: A large feature that is broken down into multiple linked issues.
-labels: ["kind/epic", "status/triage"]
-body:
-  - type: textarea
-    attributes:
-      label: Description
-      description: Describe the feature at a high-level.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Discussion
-      description: |
-        Provide a link to the GitHub Discussion for the feature.
-    validations:
-      required: true
-  - type: textarea
-    attributes:
-      label: Issues
-      description: List the issues related to this epic.
-      placeholder: |
-        - #1
-        - #2
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Motivation
-      description: Provide a brief explanation of why the feature should be added.
-    validations:
-      required: false
--- a/docs/documentation/.github/ISSUE_TEMPLATE/feature.yml
+++ b/docs/documentation/.github/ISSUE_TEMPLATE/feature.yml
@ -1,31 +0,0 @@
-name: Feature Request
-description: Request a new feature to be added to Keycloak
-labels: ["kind/feature", "status/triage"]
-body:
-  - type: textarea
-    attributes:
-      label: Description
-      description: Describe the feature at a high-level.
-    validations:
-      required: true
-  - type: input
-    attributes:
-      label: Discussion
-      description: |
-        If there has been a discussion around the feature, provide a link to the discussion.
-
-        Please note that all, except small requests, should be discussed through [GitHub Discussion](https://github.com/keycloak/keycloak/discussions/categories/ideas).
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Motivation
-      description: Describe why the feature should be added.
-    validations:
-      required: false
-  - type: textarea
-    attributes:
-      label: Details
-      description: Design ideas? Implementation ideas? Anything that will give us more context about the feature you are proposing!
-    validations:
-      required: false
--- a/docs/documentation/.github/ISSUE_TEMPLATE/task.yml
+++ b/docs/documentation/.github/ISSUE_TEMPLATE/task.yml
@ -1,10 +0,0 @@
-name: Task
-description: Any tasks that are not directly adding a new feature, enhancement or fixing a bug
-labels: ["kind/task"]
-body:
-  - type: textarea
-    attributes:
-      label: Description
-      description: Describe the task.
-    validations:
-      required: true
--- a/docs/documentation/README.md
+++ b/docs/documentation/README.md
@ -19,14 +19,14 @@ Building Keycloak Documentation

 Ensure that you have [Maven installed](https://maven.apache.org/).

-First, clone the Keycloak Documentation repository:
+First, clone the Keycloak repository:

-    git clone https://github.com/keycloak/keycloak-documentation.git
-    cd keycloak-documentation
+    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-documentation.git
+    git clone -c core.symlinks=true https://github.com/keycloak/keycloak.git

 To build Keycloak Documentation run:

--- a/docs/documentation/pom.xml
+++ b/docs/documentation/pom.xml
@ -2,6 +2,13 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

+    <parent>
+        <artifactId>keycloak-docs-parent</artifactId>
+        <groupId>org.keycloak</groupId>
+        <version>999.0.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
    <name>Keycloak Documentation Parent</name>
    <groupId>org.keycloak.documentation</groupId>
    <artifactId>documentation-parent</artifactId>
--- a/docs/pom.xml
+++ b/docs/pom.xml
@ -32,5 +32,6 @@
    <modules>
        <module>maven-plugin</module>
        <module>guides</module>
+        <module>documentation</module>
    </modules>
 </project>