chore: setup website for docs

[iddan]

closes #33

[codecov-commenter]

Codecov Report

Merging #97 (7f64b41) into main (c2d6110) will not change coverage.
The diff coverage is n/a.

❗ Current head 7f64b41 differs from pull request most recent head 4be6966. Consider uploading reports for the commit 4be6966 to get more accurate results

@@           Coverage Diff           @@
##             main      #97   +/-   ##
=======================================
  Coverage   50.81%   50.81%           
=======================================
  Files          34       34           
  Lines         555      555           
  Branches      102      102           
=======================================
  Hits          282      282           
  Misses        257      257           
  Partials       16       16           

[jasonkuhrt]

@iddan I'm ready to look at this this week. Can you share a TL;DR about the change and how this works? You can answer in the form of additions to CONTRIBUTING.md for future us and community.

[iddan]

The change adds the docs directory. Within it there is a Nextra website initialised with the README text as a markdown page and configured with support for GFM markdown support

[jasonkuhrt]

@iddan did you figure out hosting yet? gh-pages? We could also consider Vercel I guess if need be.

[iddan]

Since it’s Next app without SSR we can export the website to static files and host them in GitHub pages

[iddan]

This guide defines how to do it correctly: https://lukaszwozniak.dev/blog/deploy-nextjs-app-to-github-pages-using-github-actions/

[jasonkuhrt]

@iddan can you please setup deployment automation. Here's my suggestion:

1. A GH Action
2. Looks at branch, if trunk, continue, if not, stop
3. Looks for changes to /docs (uses git)
4. If no changes stop
5. If yes changes, then build the website and make a push to the gh-pages branch in order to trigger the deployment

Regarding (2) the issue I see with that is that it doesn't not support preview deployments.

With Vercel we get preview deployments.

If we cannot have preview deployments with gh-pages then I suggest Vercel... I think.

[jasonkuhrt]

I would also like an npm script in the repo to manually force-deploy the website too.

[iddan]

I don’t think you can get preview deploys with GitHub Pages, only services like Vercel and Netlify offer this feature

[jasonkuhrt]

@iddan let's use Vercel then. I can use the Prisma Vercel account for this.

I will set that up soon.

[jasonkuhrt]

Done, but in order to proceed I need to merge some kind of docs thing to complete configuration. Right now because this isn't on trunk Verecl will not let me specify /docs as the root.

I will try to setup a minimal nextra thing on trunk now.

[jasonkuhrt]

@iddan please rebase

You should start getting preview deployments now...

Production: https://nexus-prisma.vercel.app/

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/prisma-adp/nexus-prisma/2WN2QE1cq8SYrvsKJnyVme3kW8MW
✅ Preview: https://nexus-prisma-git-fork-iddan-feature-docs-prisma-adp.vercel.app

[iddan]

Ready to merge

[jasonkuhrt]

Some things:

• The contents are out of date with the current README on trunk
• The trunk README should become minimal and link to the website

Looking at this:

If any of the following is a quickwin please do:

• Can we have more level of nesting in the left sidebar?
• Can we remove the "Index" parent section, makes no sense
• I guess if we combine the two points above it means each current subsection becomes a top level section and then some new subsections would bubble up
• styling isn't very nice but not sure there is an easy theme we can plug there
• don't like the code highlighting theme

• Copywrite should be Prisma Data Inc.
• Would like to remove the "edit this page" link

[jasonkuhrt]

I setup a new domain for us https://nexus.prisma.io/

Thanks @janpio for the slick name idea.

[iddan]

The text I’ve put there was for demonstration purposes. I was expecting once this PR is merged that the content of the website will be changed as you’d like. I’ll make the changes.

[iddan]

• Can we have more level of nesting in the left sidebar?
• Can we remove the "Index" parent section, makes no sense
• I guess if we combine the two points above it means each current subsection becomes a top level section and then some new subsections would bubble up
• styling isn't very nice but not sure there is an easy theme we can plug there
• don't like the code highlighting theme
• Copywrite should be Prisma Data Inc.
• Would like to remove the "edit this page" link

Can the PR be merged and improvements to the left points be done in additional PRs?

[jasonkuhrt]

Thanks @iddan!

[rostislav-simonik-nexus-prisma-admin]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• npm package (@next-major dist-tag)
• GitHub release

Your semantic-release bot 📦🚀