Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(dinosaurdocs): upgrade to docusaurus v3 #697

Merged
merged 5 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- name: Set Node Version
uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18

- name: Get yarn cache directory path
id: yarn-cache-dir-path
Expand Down Expand Up @@ -104,7 +104,7 @@ jobs:
- name: Set Node Version
uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18

- name: Get yarn cache directory path
id: yarn-cache-dir-path
Expand All @@ -116,9 +116,9 @@ jobs:
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-16-yarn-${{ hashFiles('**/yarn.lock') }}
key: ${{ runner.os }}-18-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-16-yarn-
${{ runner.os }}-18-yarn-

- name: Install Dependencies
run: yarn install --immutable
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ jobs:
- name: Version Bump Dry Run
run: yarn version:dry-run

- name: Build Docs (Node 16+ only)
if: ${{matrix.node > 14}}
- name: Build Docs (Node 18+ only)
if: ${{matrix.node > 16}}
run: yarn build:docs

- name: Build App
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/recipes/testing-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Testing Libraries
---

By default `@testing-library/react` and `@testing-library/jest-dom/extend-expect` are added to the project. Some of their scripts are also automatically added to the `setupFilesAfterEnv` param for jest [here](https://github.com/Availity/availity-workflow/blob/master/packages/workflow/jest.config.js#L42).
By default `@testing-library/react` and `@testing-library/jest-dom/extend-expect` are added to the project. Some of their scripts are also automatically added to the `setupFilesAfterEnv` param for jest [here](https://github.com/Availity/availity-workflow/blob/master/packages/workflow/jest.config.js#L38).

- `@testing-library/react/cleanup-after-each` - Will clean up the DOM after each test has ran.
- `@testing-library/jest-dom/extend-expect` - Custom jest matchers that you can use to extend jest
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/reference/mock-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ app.listen(3001);
- **port**: Server binds and listens for connections on the specified port. Default is `9999`.
- **data**: Path to folder that contains the json mock responses.
- **routes**: Path(s) to configuration file that contains a mapping of the request/response routes. Multiple paths can be passed in with an array of strings.
- **plugins**: Array of NPM module names that enhance `@availity/mock-server` with additional data and routes. @See [@availity/mock-data](https://github.com/Availity/@availity/mock-data)
- **plugins**: Array of NPM module names that enhance `@availity/mock-server` with additional data and routes. @See [@availity/mock-data](https://github.com/Availity/availity-workflow/tree/master/packages/mock-data)
- **logProvider**: Function that returns a logger that is used in place of the default logger. Inspired by the log provider in [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware)
- **pluginContext**: A url context value which is used to rewrite every instance of `${context}` variable in mock data responses. This can be useful for HATEOS links.

Expand Down
39 changes: 16 additions & 23 deletions docusaurus/docs/tutorial/dependency-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,13 @@ Availity released `[email protected]` to modernize the stack even further

## Changelog

All Availity open-source projects maintain a changelog. Each project maintains it's own changelog. The changelog can be found either in the `releases` link on GitHub or as a `CHANGELOG.md` at the root of the project.

### Releases Examples

- <https://github.com/Availity/availity-workflow/releases>
- <https://github.com/Availity/sdk-js/releases>
- <https://github.com/Availity/availity-uikit/releases>
- <https://github.com/Availity/sdk-js/releases>
All Availity open-source projects maintain a changelog. Each project maintains it's own changelog. The changelog can be found in `CHANGELOG.md` for each package within a project.

### Changelog.md Examples

- <https://github.com/Availity/sdk-js/blob/master/CHANGELOG.md>
- <https://github.com/Availity/availity-workflow/blob/master/CHANGELOG.md>
- <https://github.com/Availity/availity-react/blob/master/CHANGELOG.md>
- [`availity-workflow` changelog](https://github.com/Availity/availity-workflow/blob/master/packages/workflow/CHANGELOG.md)
- [`sdk-js/analytics-core` changelog](https://github.com/Availity/sdk-js/blob/master/packages/analytics-core/CHANGELOG.md)
- [`availity-react/analytics` changelog](https://github.com/Availity/availity-react/blob/master/packages/analytics/CHANGELOG.md)

## Tools

Expand All @@ -57,20 +50,20 @@ awesome-bootstrap-checkbox 0.3.7 0.3.7 1.0.0
bootstrap 3.3.7 3.3.7 4.0.0 availity-toolkit > availity-uikit
```

### `npm-check`

<https://www.npmjs.com/package/npm-check>
### `yarn upgrade-interactive --latest`

```bash
npm-check -u
? Choose which packages to update.

Major Update Potentially breaking API changes. Use caution.
❯◉ bootstrap 3.3.7 ❯ 4.0.0 <https://getbootstrap.com>
◯ select2 3.5.2-browserify ❯ 4.0.5 <https://select2.org>
◯ lint-staged devDep 6.1.1 ❯ 7.0.0 <https://github.com/okonet/lint-staged#readme>

Space to select. Enter to start upgrading. Control-C to cancel.
❯ yarn upgrade-interactive --latest
yarn upgrade-interactive v1.22.19
info Color legend :
"<red>" : Major Update backward-incompatible updates
"<yellow>" : Minor Update backward-compatible features
"<green>" : Patch Update backward-compatible bug fixes
? Choose which packages to update. (Press <space> to select, <a> to toggle all, <i> to invert selection)
dependencies
name range from to url
❯◯ @availity/favorites latest 3.4.3 ❯ 5.0.1 https://availity.github.io/availity-react/components/favorites/index
◯ @availity/spaces latest 6.6.1 ❯ 8.0.1 https://availity.github.io/availity-react/components/spaces/index
```

## FAQ
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/tutorial/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ git push && git push --tags

Congratulations! You successfully created your first deployment artifact! You can choose to read more about the additional features that our Workflow toolkit provides in the `Recipes` section.

Checkout our [React Component Library](https://availity.github.io/availity/react) for some pre-built reactstrap components to assist in building solid web applications.
Checkout our [React Component Library](https://availity.github.io/availity-react/) for some pre-built reactstrap components to assist in building solid web applications.
2 changes: 1 addition & 1 deletion docusaurus/docs/tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

Throughout the documentation you will see [yarn](https://yarnpkg.com/) used. You are not required to use this however it is our package manager of choice. If you are still wanting to use npm then just note the subtle differences in the commands. `yarn start` would be the same `npm start`.

The minimum required [Nodejs](https://nodejs.org/) version to run and use our toolkit is `v12.19.0`, but using `v14.17.6` or higher is recommended.
The minimum required [Nodejs](https://nodejs.org/) version to run and use our toolkit is `v16.0.0`, but using `v18.0.0` or higher is recommended.

## Creating a new App Using the Workflow CLI

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
"serve": "docusaurus serve"
},
"dependencies": {
"@docusaurus/core": "^2.4.1",
"@docusaurus/preset-classic": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@mdx-js/react": "^3.0.1",
"clsx": "^2.0.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
Loading
Loading