Merge branch 'FusionAuth:main' into feat/fusionauth-swift-sdk

.github/workflows/contentcheck.yml

@@ -2,10 +2,6 @@
 name: content_check
 on: 
   pull_request:
-  # run once a day
-  schedule:
-    - cron: '13 19 * * *'
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
@@ -18,79 +14,33 @@ jobs:
       - uses: actions/checkout@v4
       - name: Check for blog posts that have incorrect categories
         run: |
-          find astro/src/content/blog/ -type f -name "*.md*" |grep -v swp | xargs grep '^categories:'|sed 's/.*categories: //'|sed 's/, /\n/g'|sort -u  > out
-          RES=`diff out config/contentcheck/known-blog-categories.txt`
-          exit $RES
+          exit `src/scripts/check-for-incorrect-categories.sh`
         shell: bash
-      - name: Grep for absolute URLs referencing FusionAuth.io
-        continue-on-error: true
-        # we ignore 'open your browser and navigate to https://fusionauth.io/docs' because it is part of command output
-        # we ignore 'homepage "https://fusionauth.io"' because it is part of the homebrew formula
-        # we ignore "<a href='https://fusionauth.io/docs/v1/tech/tutorials/'>Learn how this app works.</a>" because it is part of a react tutorial
-        # we use continue-on-error because grep -v exits with code 1 if it doesn't find anything, but that's what we want.
+      - name: No absolute URLs referencing FusionAuth.io
         run: |
-          find astro/src/content/ -type f -name "*.md*" | xargs grep 'https://fusionauth.io' | grep -v 'homepage "https://fusion' | grep -v 'open your browser and navigate to https://fusionauth.io/docs' |grep -v "<a href='https://fusionauth.io/docs/'>Learn how this app works.</a>" > absolute.out
-        shell: bash
-      - name: Check for absolute URLs referencing FusionAuth.io from file. Keep this next to 'Grep for absolute URLs referencing FusionAuth.io'
-        run: |
-          cat absolute.out
-          exit `cat absolute.out | wc -l | sed 's/[ ]*//g'`
-        shell: bash
-      - name: Check for old asciidoc styling syntax
-        run: |
-          exit `find astro/src/content/docs/ -type f | xargs grep ']#'| wc -l |sed 's/[ ]*//g'`
-        shell: bash
-      - name: Check for old asciidoc code import
-        run: |
-          exit `find astro/src/content/docs/ -type f | xargs grep '++++'| wc -l |sed 's/[ ]*//g'`
-        shell: bash
-      - name: Check for old doc nav url references
-        run: |
-          exit `find astro/src/content/ -type f | xargs grep 'docs/v1/tech'| wc -l |sed 's/[ ]*//g'`
+          exit `src/scripts/check-for-absolute-urls.sh`
         shell: bash
       - name: Check for erroneous markdown references
         run: |
-          exit `find astro/src/content/ -type f -name "*.md*" | xargs grep ']()'| wc -l |sed 's/[ ]*//g'`
+          exit `src/scripts/check-for-incorrect-markdown-references.sh`
         shell: bash
       - name: Make sure all docs have a full sentence in their description.
         run: |
-          exit `find astro/src/content/docs/ -type f -print|grep -v '/_' |xargs grep '^description: '|grep -v '\.$'|wc -l |sed 's/[ ]*//g'`
-        shell: bash
-      - name: Make sure docs don't use old asciidoc icon references
-        run: |
-          exit `find astro/src/content/docs/ -type f -print|xargs grep -l 'icon:[a-z]'| wc -l |sed 's/[ ]*//g'`
+          exit `src/scripts/check-for-full-sentences-in-docs-descriptions.sh`
         shell: bash
       - name: check for APIFields with no name
         run: |
-          echo `grep -R \<APIField astro/src/content/docs | grep -v name`
-          exit `find astro/src/content/docs/ -type f -print|xargs grep \<APIField | grep -v name | wc -l | sed 's/[ ]*//g'`
+          exit `src/scripts/check-for-api-fields-no-name.sh`
         shell: bash
       - name: check for the word 'edition' which we don't use any more, excluding files it is okay to have 'edition' in
         run: |
-          echo `grep -Ri edition astro/src/content | grep -v 'IDEA'|grep -v 'Scouting'|grep -v '0-reactor-ed'|grep -v 'Gluu Server Community Edition'|grep -v 'TR/webauthn-2/'|grep -v 'API-Security/editions'|grep -v fusionauth-colorado-company-to-watch|grep -v 'edition.cnn.com'|grep -v 'hey are also called editions'|grep -v 'also known as an edition'`
-          exit `find astro/src/content -type f -print|xargs grep -i edition | grep -v 'IDEA'|grep -v 'Scouting'|grep -v '0-reactor-ed'|grep -v 'Gluu Server Community Edition'|grep -v 'TR/webauthn-2/'|grep -v 'API-Security/editions'|grep -v fusionauth-colorado-company-to-watch|grep -v 'edition.cnn.com'|grep -v 'hey are also called editions'|grep -v 'also known as an edition' | wc -l | sed 's/[ ]*//g'`
+          exit `src/scripts/check-for-use-of-word-edition.sh`
         shell: bash
       - name: check for the proper casing of word 'plan' which should always be lowercase when prefixed by Community, Starter, Enterprise or Essentials
         run: |
-          # uncomment to troubleshoot or run locally. If this is uncommented and finds nothing (which is expected state) then it errors out and the GH workflow fails.
-          #find astro/src/content -type f|xargs egrep '(Enterprise|Community|Starter|Essentials) Plan' |grep -v '^##'
-          exit `find astro/src/content -type f|xargs egrep '(Enterprise|Community|Starter|Essentials) Plan'|grep -v '^##'|wc -l | sed 's/[ ]*//g'`
-        shell: bash
-      - name: check for the proper casing of plans, such as Community, Starter, Enterprise or Essentials
-        run: |
-          # uncomment to troubleshoot or run locally. If this is uncommented and finds nothing (which is expected state) then it errors out and the GH workflow fails.
-          #find astro/src/content -type f|xargs egrep '(enterprise|community|starter|essentials) plan'|grep -v '^##'
-          exit `find astro/src/content -type f|xargs egrep '(enterprise|community|starter|essentials) plan'|grep -v '^##' |wc -l | sed 's/[ ]*//g'`
-        shell: bash
-      - name: check for old style asciidoc URLs 
-        run: |
-          echo `grep -R 'https://[^[]*\[' astro/src/content/docs |grep -v '(' | grep -v '[200]'` 
-          exit `find astro/src/content/docs/ -type f -print|xargs grep 'https://[^[]*\[' astro/src/content/docs |grep -v '(' |grep -v '[200]'  | wc -l | sed 's/[ ]*//g'`
-          # ignore the '[200]' because that is a valid case that grep picks up incorrectly
+          exit `src/scripts/check-for-use-proper-casing-of-plan.sh`
         shell: bash
       - name: check unsorted vale keywords. error to fix because this decreases merge conflicts
         run: |
-          # first line shows output of unsorted item, second just an exit code. this needs to be LC_ALL=C because otherwise you run into issues between how macos sorts it and how linux/GH actions sorts it
-          echo `LC_ALL=C sort -cu config/vale/styles/config/vocabularies/FusionAuth/accept.txt`
-          exit `LC_ALL=C sort -Cu config/vale/styles/config/vocabularies/FusionAuth/accept.txt`
+          exit `src/scripts/check-vale-vocab-sorted.sh`
         shell: bash

DocsDevREADME.md

@@ -36,6 +36,7 @@ Here are some guidelines to follow when writing documentation (everything under
 - Headers should have the first letter of every word capitalized: `This Is The Header Text`. This is true for all headers (h1, h2, h3, h4). This is also known as [Start Case](https://en.wikipedia.org/wiki/Letter_case).
 - When writing, you have access to Asides. Here's an [example blog post using an Aside](https://github.com/FusionAuth/fusionauth-site/blob/main/astro/src/content/blog/log4j-fusionauth.mdx). You can assign the following values to the type: `tip` for tips. `note` for things for the user to be aware of. `important` for things the user should pay attention to. `warn` for dangerous actions like deleting a tenant.
 - For links, don't use the absolute URL for the FusionAuth website (https://fusionauth.io), only relative URLs. This allows us to deploy to our local and staging environments and not get sent over to prod.
+- If you have a list element containing more than one paragraph, indent the second paragraph by the same amount as the start of the text in the first paragraph to make sure that it renders correctly.
 
 ## Docs 
 - Don't use complex breadcrumbs styling in docs. Use `->`. Use the [Breadcrumb](astro/src/components/Breadcrumb.astro) component. Breadcrumbs should look like this `<Breadcrumb>foo -> bar -> baz</Breadcrumb>`.

astro/src/components/Aside.astro

@@ -3,7 +3,7 @@
 
 // Adapted from https://github.com/withastro/docs/blob/main/src/components/Aside.astro
 export interface Props {
-	type?: 'note' | 'tip' | 'caution' | 'danger' | 'database' | 'version';
+	type?: 'note' | 'tip' | 'caution' | 'danger' | 'database' | 'theme' | 'version';
 	title?: string;
 	titleBold?: boolean;
 	nodark?: boolean;
@@ -31,11 +31,15 @@ const icons: Record<NonNullable<Props['type']>, { viewBox: string; d: string }>
 	},
 	database: {
 		viewBox: '0 0 16 16',
-		d: 'M1 3.5c0-.626.292-1.165.7-1.59.406-.422.956-.767 1.579-1.041C4.525.32 6.195 0 8 0c1.805 0 3.475.32 4.722.869.622.274 1.172.62 1.578 1.04.408.426.7.965.7 1.591v9c0 .626-.292 1.165-.7 1.59-.406.422-.956.767-1.579 1.041C11.476 15.68 9.806 16 8 16c-1.805 0-3.475-.32-4.721-.869-.623-.274-1.173-.62-1.579-1.04-.408-.426-.7-.965-.7-1.591Zm1.5 0c0 .133.058.318.282.551.227.237.591.483 1.101.707C4.898 5.205 6.353 5.5 8 5.5c1.646 0 3.101-.295 4.118-.742.508-.224.873-.471 1.1-.708.224-.232.282-.417.282-.55 0-.133-.058-.318-.282-.551-.227-.237-.591-.483-1.101-.707C11.102 1.795 9.647 1.5 8 1.5c-1.646 0-3.101.295-4.118.742-.508.224-.873.471-1.1.708-.224.232-.282.417-.282.55Zm0 4.5c0 .133.058.318.282.551.227.237.591.483 1.101.707C4.898 9.705 6.353 10 8 10c1.646 0 3.101-.295 4.118-.742.508-.224.873-.471 1.1-.708.224-.232.282-.417.282-.55V5.724c-.241.15-.503.286-.778.407C11.475 6.68 9.805 7 8 7c-1.805 0-3.475-.32-4.721-.869a6.15 6.15 0 0 1-.779-.407Zm0 2.225V12.5c0 .133.058.318.282.55.227.237.592.484 1.1.708 1.016.447 2.471.742 4.118.742 1.647 0 3.102-.295 4.117-.742.51-.224.874-.47 1.101-.707.224-.233.282-.418.282-.551v-2.275c-.241.15-.503.285-.778.406-1.247.549-2.917.869-4.722.869-1.805 0-3.475-.32-4.721-.869a6.327 6.327 0 0 1-.779-.406Z',
+		d: 'M0.516875615,4.52883527 C-0.183714866,3.42945088 -0.160964634,2.34044349 0.517458955,1.24105911 C0.583376294,1.13383022 0.683710651,1.05023781 0.801545187,1.00354135 C4.16857954,-0.334513785 9.83163732,-0.334513785 13.1986717,1.00354135 C13.3165062,1.05023781 13.4168406,1.13383022 13.4827579,1.24105911 C14.1605982,2.34044349 14.1839317,3.42945088 13.4833412,4.52883527 C13.4174239,4.63260516 13.3176729,4.71389158 13.2027551,4.75943503 C9.83513736,6.09979617 4.16566284,6.09979617 0.797461812,4.75943503 C0.682543972,4.71389158 0.583376294,4.63260516 0.516875615,4.52883527 Z M7.00020483,6.73119195 C4.52503391,6.73119195 2.22786986,6.3918604 0.474648108,5.77623101 C0.38476923,5.74471415 0.28321777,5.78305967 0.248200026,5.86395295 C-0.154504038,6.80157961 -0.0681269345,7.88418385 0.514334885,8.7556251 C0.579701342,8.85332737 0.680085543,8.927392 0.797394988,8.96993977 C4.16668565,10.1864907 9.83314037,10.1864907 13.202431,8.96993977 C13.3197405,8.927392 13.4201247,8.85332737 13.4854911,8.7556251 C14.0685366,7.88418385 14.1543301,6.80105433 13.751626,5.86342767 C13.7166083,5.78253439 13.6150568,5.74418887 13.5251779,5.77570573 C11.7731234,6.3918604 9.47537575,6.73119195 7.00020483,6.73119195 Z M13.925613,10.0088025 C13.9063346,9.91197406 13.7900801,9.85708732 13.6872621,9.89385108 C11.9159876,10.5250485 9.5301417,10.8838835 7,10.8838835 C4.4698583,10.8838835 2.08401238,10.5250485 0.312737938,9.89385108 C0.209919896,9.85708732 0.0936654058,9.91197406 0.074387023,10.0088025 C-0.122486159,10.9853721 0.0702976691,12.0012945 0.666174956,12.8002589 C0.724010104,12.8779288 0.805797183,12.9385113 0.900436517,12.9778641 C2.5531197,13.659288 4.77655985,14 7,14 C9.22344015,14 11.4468803,13.6587702 13.0995635,12.9778641 C13.194787,12.9385113 13.2759899,12.8779288 13.333825,12.8002589 C13.9297023,12.0012945 14.1224862,10.9853721 13.925613,10.0088025 Z',
 	},
 	version: {
 		viewBox: '0 0 16 16',
 		d: 'M7.75 0a.75.75 0 0 1 .75.75V3h3.634c.414 0 .814.147 1.13.414l2.07 1.75a1.75 1.75 0 0 1 0 2.672l-2.07 1.75a1.75 1.75 0 0 1-1.13.414H8.5v5.25a.75.75 0 0 1-1.5 0V10H2.75A1.75 1.75 0 0 1 1 8.25v-3.5C1 3.784 1.784 3 2.75 3H7V.75A.75.75 0 0 1 7.75 0Zm4.384 8.5a.25.25 0 0 0 .161-.06l2.07-1.75a.248.248 0 0 0 0-.38l-2.07-1.75a.25.25 0 0 0-.161-.06H2.75a.25.25 0 0 0-.25.25v3.5c0 .138.112.25.25.25h9.384Z',
+	},
+	theme: {
+		viewBox: '0 0 16 16',
+		d: 'M7.53 1.282a.5.5 0 0 1 .94 0l.478 1.306a7.492 7.492 0 0 0 4.464 4.464l1.305.478a.5.5 0 0 1 0 .94l-1.305.478a7.492 7.492 0 0 0-4.464 4.464l-.478 1.305a.5.5 0 0 1-.94 0l-.478-1.305a7.492 7.492 0 0 0-4.464-4.464L1.282 8.47a.5.5 0 0 1 0-.94l1.306-.478a7.492 7.492 0 0 0 4.464-4.464Z'
 	}
 };
 const { viewBox, d } = icons[type];
@@ -46,6 +50,7 @@ const bgColors: Record<NonNullable<Props['type']>, string> = {
 	caution: 'border-yellow-500 bg-yellow-50' + (!nodark ? ' dark:bg-yellow-700 dark:bg-opacity-20' : ''),
 	danger: 'border-red-500 bg-red-50' + (!nodark ? ' dark:bg-red-900 dark:bg-opacity-30' : ''),
 	database: 'border-orange-500 bg-orange-50' + (!nodark ? ' dark:bg-orange-900 dark:bg-opacity-30' : ''),
+	theme: 'border-fuchsia-500 bg-fuchsia-50' + (!nodark ? ' dark:bg-fuchsia-700 dark:bg-opacity-20' : ''),
 	version: 'border-green-500 bg-green-50' + (!nodark ? ' dark:bg-green-900 dark:bg-opacity-30' : ''),
 };
 const bgColor = bgColors[type];