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

docs: rewrite with vitepress #783

Merged
merged 88 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from 79 commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
da45146
removed old doc workflows
zoey-kaiser Jul 1, 2024
e32b0f9
removed docus, installed basic vitepress
zoey-kaiser Jul 1, 2024
684d8a9
Re-added previously written docs
zoey-kaiser Jul 1, 2024
45d1159
changed env to no language
zoey-kaiser Jul 1, 2024
13f38e7
removed comments about pages
zoey-kaiser Jul 1, 2024
80cdb32
finished docs for custom pages and began docs for session data modifi…
zoey-kaiser Jul 1, 2024
f6243d3
Finished AuthJS docs
zoey-kaiser Jul 2, 2024
76f9c87
added server side docs for authjs provider
zoey-kaiser Jul 2, 2024
0d2d2c9
bagn session access docs
zoey-kaiser Jul 2, 2024
807c5c8
added docs for session access and managment
zoey-kaiser Jul 2, 2024
740bb07
added middleware docs
zoey-kaiser Jul 2, 2024
ad8489d
added configuration props
zoey-kaiser Jul 2, 2024
5cd9e9d
Added configuration options to the authjs provider
zoey-kaiser Jul 2, 2024
25b3db6
began adding local / refresh docs
zoey-kaiser Jul 2, 2024
1b79fe9
added session data types docs for local / refresh
zoey-kaiser Jul 2, 2024
55197ad
added caching content docs
zoey-kaiser Jul 2, 2024
6cc93fd
Linked some more docs with one another
zoey-kaiser Jul 2, 2024
125895f
updated docs to match 0.8.0 release and added refreshOnlyToken option
zoey-kaiser Jul 2, 2024
0f5a481
added docs on refreshHandler
zoey-kaiser Jul 2, 2024
48dd36a
removed unneeded local docs
zoey-kaiser Jul 2, 2024
6eb5465
Added resources to docs
zoey-kaiser Jul 2, 2024
ec69d58
Updated introduction texts
zoey-kaiser Jul 2, 2024
06b3d42
updated github link to go with NuxtAuth repo
zoey-kaiser Jul 2, 2024
a4d7155
removed unused soon file
zoey-kaiser Jul 2, 2024
1a32bfb
add test version of docs deploy
zoey-kaiser Jul 2, 2024
3c64bfe
fix: correct demo deploy branch name
zoey-kaiser Jul 2, 2024
347126b
change trigger of deploy workflow
zoey-kaiser Jul 2, 2024
d4bb77e
specify pnpm version
zoey-kaiser Jul 2, 2024
d851490
change ci to in install
zoey-kaiser Jul 2, 2024
3cf6dd4
change dir before building docs
zoey-kaiser Jul 2, 2024
4012212
fix: dead docs links
zoey-kaiser Jul 2, 2024
c04b5d1
use clean urls instead of displaying file extension
zoey-kaiser Jul 2, 2024
0fa97a2
Spelling fixes
zoey-kaiser Jul 4, 2024
508f40c
add next steps to authjs docs
zoey-kaiser Jul 4, 2024
d34fd2d
Merge branch 'main' into docs/migrate-to-vitepress
zoey-kaiser Jul 4, 2024
7a078f7
removed api docs link from navbar
zoey-kaiser Jul 4, 2024
762d96d
remove recipies url and split guide into authjs and local
zoey-kaiser Jul 4, 2024
f55b842
added self hosted deployment docs
zoey-kaiser Jul 4, 2024
1606bc4
Added Vercel and Netlify deployment docs
zoey-kaiser Jul 4, 2024
e4d91eb
fixed small typo
zoey-kaiser Jul 4, 2024
cda55d5
last minor config changes
zoey-kaiser Jul 4, 2024
583a3ac
added new icons
zoey-kaiser Jul 4, 2024
3f34456
added github star counter
zoey-kaiser Jul 4, 2024
1e3e427
minor rewrites
zoey-kaiser Jul 4, 2024
5d66aa4
remove github stars button
zoey-kaiser Jul 4, 2024
ef81d2d
Discard changes to pnpm-lock.yaml
zoey-kaiser Jul 4, 2024
958e836
regenerate lock file changes
zoey-kaiser Jul 4, 2024
51aa8e6
add CNAME File
zoey-kaiser Jul 9, 2024
8192fb4
Merge branch 'main' into docs/migrate-to-vitepress
zoey-kaiser Jul 9, 2024
ec1b77a
changed baseurl
zoey-kaiser Jul 9, 2024
8cf0f8a
Change BASEURL
zoey-kaiser Jul 9, 2024
f71a090
Fix: Spelling / Grammer, small rewrite from @phoenix-ru
zoey-kaiser Jul 11, 2024
1a0c518
Updated feature table and added links
zoey-kaiser Jul 11, 2024
536c16d
improved RefreshHandler Docs
zoey-kaiser Jul 11, 2024
9262ac0
deleted old middleware files
zoey-kaiser Jul 11, 2024
4c59b10
Update docs/guide/application-side/session-access.md
zoey-kaiser Jul 11, 2024
2de98ad
last adjustments proposed by @phoenix-ru
zoey-kaiser Jul 11, 2024
4b835b9
Merge branch 'docs/migrate-to-vitepress' of github.com:sidebase/nuxt-…
zoey-kaiser Jul 11, 2024
c15f6ce
added Github Star Button
zoey-kaiser Jul 11, 2024
590746c
Added an annoucement banner
zoey-kaiser Jul 11, 2024
a3c5156
fixed for authjs docs
zoey-kaiser Jul 11, 2024
26cec41
change basePath to baseURL and add link to nuxt config
zoey-kaiser Jul 11, 2024
4de59e1
add correct install method
zoey-kaiser Jul 11, 2024
5968cea
fix middleware docs
zoey-kaiser Jul 11, 2024
76e75fc
Merge branch 'docs/migrate-to-vitepress' of github.com:sidebase/nuxt-…
zoey-kaiser Jul 11, 2024
446bf50
Apply suggestions from code review
zoey-kaiser Jul 11, 2024
9fd56ce
began updating Readme to match new docs
zoey-kaiser Jul 12, 2024
426730a
Merge branch 'docs/migrate-to-vitepress' of github.com:sidebase/nuxt-…
zoey-kaiser Jul 12, 2024
ace520d
Slight ReadME Adjustments
zoey-kaiser Jul 12, 2024
599f6d3
adjusted some spacing in the ReadME
zoey-kaiser Jul 12, 2024
313afd3
moved package description above badges
zoey-kaiser Jul 12, 2024
992cf44
remove description down a bit
zoey-kaiser Jul 12, 2024
497eeae
re-add description into block quote
zoey-kaiser Jul 12, 2024
cfa795e
adjusted demo page section
zoey-kaiser Jul 12, 2024
394e888
added acknowledgements section
zoey-kaiser Jul 12, 2024
8fc6370
added link to Nuxt 3 team and removed width constraint from contribut…
zoey-kaiser Jul 12, 2024
98a2626
added section for contributing and contributing guide
zoey-kaiser Jul 12, 2024
8afaed3
First version of contributing guidelines
zoey-kaiser Jul 12, 2024
2e34b55
added docs prefix to branch names
zoey-kaiser Jul 12, 2024
d1e87d6
rounded github button to match other components
zoey-kaiser Jul 12, 2024
def0baf
added full example of authjs and normal config
zoey-kaiser Jul 12, 2024
ad60530
remove unneeded defineProps imports
zoey-kaiser Jul 12, 2024
d9eec51
only deploy docs on push to main and added docs build to CI
zoey-kaiser Jul 12, 2024
6e1d302
fix ci
zoey-kaiser Jul 12, 2024
55dd55a
remove extra line
zoey-kaiser Jul 12, 2024
8543289
remove failed docs ci step
zoey-kaiser Jul 12, 2024
bead0ac
re-added docs build to ci
zoey-kaiser Jul 12, 2024
1e91bbc
undo env based node version for docs deploy pipeline
zoey-kaiser Jul 12, 2024
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
130 changes: 130 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Contributing guide

Thank you to everyone who has contributed to this project by writing issues or opening pull requests. Your efforts help us improve and grow. We appreciate your support and look forward to your contributions!

Please see the GitHub [Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines) and follow any templates configured in GitHub when reporting bugs, requesting enhancements, or contributing code.

If you would like to report a security vulnerability, please DO NOT post an issue but instead follow our [Security reporting guide](/SECURITY.md).

## Bug reports

A bug is a reproducible issue caused by the package. Reporting bugs is very helpful and allows us to address problems efficiently!

### Before opening an issue

Before opening a [new bug report](https://github.com/sidebase/nuxt-auth/issues/new?assignees=&labels=bug%2Cpending&projects=&template=bug-report.yaml), please:

- **Search for other issues relating to this bug** using the Github Issue search
- **Check if the issue may have already been patched** in a newer version or inside the `main` branch
- **Isolate the issue** and create a reproduction

Please refer to the fantastic Nuxt [bug report guidelines here](https://nuxt.com/docs/community/reporting-bugs) for more details on efficiently describing bugs.

### Opening an issue

To report a bug, please [open an issue](https://github.com/sidebase/nuxt-auth/issues/new?assignees=&labels=bug%2Cpending&projects=&template=bug-report.yaml) based on our Bug Reporting template. The template will prompt you with questions that will increase our ability to scope and address the bug.

## Feature requests

Feature requests are divided into two types:

- **Enhancements**: Improve or extend an existing feature of the package
- **Feature request**: Add a new feature to the package

Both types can be created using our [Enchantment issue template](https://github.com/sidebase/nuxt-auth/issues/new?assignees=&labels=pending%2Cenhancement&projects=&template=enhancement.yml).

Before posting an enchantment, please consider the following questions:

- What problem does this enhancement fix?
- How would you recommend implementing this enhancement?
- How would this enhancement change the entire package?
- Would it require a major, minor, or patch release?
- Which providers would be impacted by this change?

> [!IMPORTANT]
> The more impact your Enchantment has on the package, the longer it may take to push, as we need to integrate it into our release cycle.

> [!IMPORTANT]
> While we appreciate every request, we cannot accept them all. Please be understanding if we do not accept your request.

## Pull requests

Thank you to everyone who plans to open a pull request on our package! We appreciate your hard work and motivation to help us improve!

Before opening a pull request, please open a corresponding issue outlining the bug or enhancement you are adding. If you plan to implement a more significant change to the code base, please discuss this with us in an issue before beginning your work. This is to avoid the risk of you spending a lot of time working on a contribution we may disagree with.

### Your first contribution

To start developing on this package, please follow the quick start guide below.

1. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the project to your own personal GitHub
1. Setup a local fork of the project:
```sh
# Clone the fork
git clone https://github.com/<username>/<fork-repo-name>
# Navigate to the directory
cd <fork-repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/sidebase/nuxt-auth
# If you cloned a while ago, checkout the main branch and re-pull the latest changes
git checkout main
git pull
```
2. Set up the correct ppm version, using [Corepack](https://nodejs.org/api/corepack.html) and install the dependencies
```sh
corepack enable ppm
ppm install
```
4. Create a new branch (based on the `main` branch):
```sh
git checkout -b <fix/enh/docs>/<issue_number>-<description>
```
5. Update the code to include your fix or Enchantment
6. Add or update any tests that relate to your changes.
7. Ensure that the `tests,` `lint,` and `prepack` all pass
```sh
ppm prepack
ppm lint
ppm type check

# Test any provider that you have modified
cd playground-<provider>
ppm build
ppm test:e2e
```
8. [Open a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests), and fill out the provided fields.

> [!TIP]
> Read more about how to use the included playground [here](../README.md#development).

> [!IMPORTANT]
> By submitting a Pull request, you agree to license your work under the MIT license used by the project.

### Reviews

After you submit your Pull request, a member of our core team will review it. Please be patient with this process, as it can take up to 14 weeks, depending on the team's availability.

After receiving a review, please address any comments left by the reviewer or debate them if you disagree. This process will repeat until the pull request is approved and merged!

> [!NOTE]
> Besides a manual review of your pull request, we will run an automated CI pipeline on your code.

## Release cycles

This package follows [Semantic Versioning 2.0.0](https://semver.org/).

- **MAJOR** version when you make incompatible API changes
- **MINOR** version when you add functionality in a backward-compatible manner
- **PATCH** version when you make backward compatible bug fixes

If we release a pre-version of a new release, we will tag it with `next` in the npmjs release and add one of the following additions to the versions:

- **ALPHA**: Early development build of a new release
- Not properly tested yet
- **RC**: Potential release candidate of a new release
- Internally tested on a series of demo apps
- We will begin to integrate the new version into our production apps as a final test

## Additional Questions

If you have any questions or would like to get in contact with us directly, feel free to [join our Discord server](https://discord.gg/NDDgQkcv3s)!
Binary file removed .github/nuxt-auth-demo.png
Binary file not shown.
Binary file modified .github/nuxt-auth.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions .github/sync.yml

This file was deleted.

64 changes: 64 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Deploy Docs

on:
# push:
# branches: [main]
pull_request: # TODO: Remove deployment from pull requests to main
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Required to calculate lastUpdated
- name: Install pnpm
uses: pnpm/action-setup@v3
with:
version: 8
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: pnpm i
- name: Build with VitePress
run: cd docs/ && pnpm docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
17 changes: 0 additions & 17 deletions .github/workflows/sync.yaml

This file was deleted.

4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,7 @@ coverage
Network Trash Folder
Temporary Items
.apdisk

## Vite Press related
docs/.vitepress/cache
docs/.vitepress/dist
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
auth.sidebase.io
auth.sidebase.io
Loading