Skip to content

Commit

Permalink
Move items from GitHub subdir (FusionAuth#3178)
Browse files Browse the repository at this point in the history
* move spellcheck config out of .github repo

* use a config dir

* move linkcheck config out of .github repo

* move contentcheck config out of .github repo

* move linkcheck config out of .github repo

* move scripts directory out of github

* update for new location of script

* update for new location of script

* update for new location of script

* moving vale config out of .github

* updating location of various files

* added centralized sessions because that is waiting for the logout/sessions doc to go live
  • Loading branch information
mooreds authored Aug 2, 2024
1 parent d73546e commit a5e125a
Show file tree
Hide file tree
Showing 26 changed files with 16 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/contentcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- 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 .github/known-blog-categories.txt`
RES=`diff out config/contentcheck/known-blog-categories.txt`
exit $RES
shell: bash
- name: Grep for absolute URLs referencing FusionAuth.io
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/devlinkcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ jobs:
- uses: actions/checkout@v4
- uses: filiph/[email protected]
with:
arguments: https://fusionauth.dev/docs/ --skip-file .github/linkcheck-skip.txt --connection-failures-as-warnings
arguments: https://fusionauth.dev/docs/ --skip-file config/linkcheck/linkcheck-skip.txt --connection-failures-as-warnings
name: linkcheck
4 changes: 2 additions & 2 deletions .github/workflows/exampleappscheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: example_app_check
on:
pull_request:
paths:
- '.github/scripts/count-repos.sh'
- 'src/scripts/count-repos.sh'
- '.github/workflows/exampleappcheck.yml'
- 'astro/src/content/json/exampleapps.json'
- 'astro/src/content/quickstarts/**'
Expand All @@ -18,4 +18,4 @@ jobs:
- uses: actions/checkout@v4

- name: Check for example app completeness
run: .github/scripts/count-repos.sh
run: src/scripts/count-repos.sh
2 changes: 1 addition & 1 deletion .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ jobs:
- uses: actions/checkout@v4
- uses: filiph/[email protected]
with:
arguments: https://fusionauth.io/ --skip-file .github/linkcheck-skip.txt --connection-failures-as-warnings
arguments: https://fusionauth.io/ --skip-file config/linkcheck/linkcheck-skip.txt --connection-failures-as-warnings
name: linkcheck
6 changes: 3 additions & 3 deletions .github/workflows/updatesitemap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ jobs:
with:
node-version: 20
cache: 'npm'
cache-dependency-path: '.github/scripts/publish_sitemap/package-lock.json'
cache-dependency-path: '.src/scripts/publish_sitemap/package-lock.json'
- name: Install dependencies
run: cd .github/scripts/publish_sitemap && npm install
run: cd src/scripts/publish_sitemap && npm install
- name: Update sitemap
env:
GOOGLE_SEARCH_CONSOLE_JSON_KEY: ${{ secrets.GOOGLE_SEARCH_CONSOLE_JSON_KEY }}
run: node .github/scripts/publish_sitemap/publish_sitemap.js
run: node src/scripts/publish_sitemap/publish_sitemap.js
shell: bash
2 changes: 1 addition & 1 deletion .spellcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ matrix:
dictionary:
encoding: utf-8
wordlists:
- .github/knownwords.txt
- config/spellcheck/knownwords.txt
pipeline:
- pyspelling.filters.url:
- pyspelling.filters.html:
Expand Down
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
StylesPath = .github/vale/styles
StylesPath = config/vale/styles

Vocab = FusionAuth
MinAlertLevel = error
Expand Down
10 changes: 5 additions & 5 deletions DocsDevREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Follow everything in the `Content Style Guidelines` section.
- For site navigation, use double quotes: Navigate to "Tenants" and then to the "Password" tab.
- For field names, use double quotes: "Login Identifier Attribute".
- For values, use back ticks: `userPrincipalName`.
- Put each blog post into one or more of the known categories. [Here's the list](https://github.com/FusionAuth/fusionauth-site/blob/main/.github/known-blog-categories.txt). You can separate categories with commas.
- Put each blog post into one or more of the known categories. [Here's the list](https://github.com/FusionAuth/fusionauth-site/blob/main/config/contentcheck/known-blog-categories.txt). You can separate categories with commas.
- Use tags. They are separated with commas. These are freeform, so feel free to add multiple and choose what works. The first one is what is used to show related posts, unless there's a `featuredTag` value in the front matter. You can [learn more about the logic by reviewing the layout](https://github.com/FusionAuth/fusionauth-site/blob/main/astro/src/layouts/Blog.astro).
- You can use the `get-images-from-markdown.rb` script to extract images from markdown and store them in a directory.
- All references to `stackoverflow.com` should be updated and direct to the community forum at `https://fusionauth.io/community/forum/`
Expand Down Expand Up @@ -452,9 +452,9 @@ The main configuration file is located at [`.vale.ini`](./.vale.ini), where we s
### Rules
- The rules _(or, as Vale calls them, "styles")_ are located at [`.github/vale/styles`](./.github/vale/styles).
- Right now, we're using [`write-good`](./.github.vale/styles/write-good), a collection of simple rules to avoid common mistakes and awkward sentences.
- We also have a custom vocabulary at [`.github/vale/styles/config/vocabularies/FusionAuth/accept.txt`](./.github/vale/styles/config/vocabularies/FusionAuth/accept.txt) with known words.
- The rules _(or, as Vale calls them, "styles")_ are located at [`config/vale/styles`](./config/vale/styles).
- Right now, we're using [`write-good`](./config/vale/styles/write-good), a collection of simple rules to avoid common mistakes and awkward sentences.
- We also have a custom vocabulary at [`config/vale/styles/config/vocabularies/FusionAuth/accept.txt`](./config/vale/styles/config/vocabularies/FusionAuth/accept.txt) with known words.
- Note that this file can use regular expressions to match words in a case-insensitive manner, as described [in their docs](https://vale.sh/docs/topics/vocab/).

### GitHub Actions
Expand Down Expand Up @@ -488,7 +488,7 @@ $ vale --filter=".Name == 'Vale.Spelling'" astro/path/to/file
Whenever you receive an error, you need to determine if you should:

- Actually fix the word (e.g. if you received an error like _"Use 'Id' instead of 'ID'."_); or
- Add a known word to [`the vocabulary`](./.github/vale/styles/config/vocabularies/FusionAuth/accept.txt) if it's a language, library, company name, etc. But make sure you have the correct capitalization to avoid having duplicates there; or
- Add a known word to [`the vocabulary`](./config/vale/styles/config/vocabularies/FusionAuth/accept.txt) if it's a language, library, company name, etc. But make sure you have the correct capitalization to avoid having duplicates there; or
- In case of custom Astro components, you'd probably need to add a new `TokenIgnores` item in [`.vale.ini`](./.vale.ini).

## Pull request review process
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ function get_json_repos() {
# Repos that will be returned by the `gh` commands below, but are
# intentionally excluded from JSONFILE for... reasons?
local EXCLUDE=(
"fusionauth-example-node-centralized-sessions"
"fusionauth-example-ruby-on-rails-custom-scopes"
"fusionauth-example-template"
"fusionauth-example-vue-sdk"
Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit a5e125a

Please sign in to comment.