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

Task: Explore Using Nextra for Docs Site with Search + Auth #1

Open
9 of 12 tasks
nelsonic opened this issue Jun 14, 2024 · 1 comment
Open
9 of 12 tasks

Task: Explore Using Nextra for Docs Site with Search + Auth #1

nelsonic opened this issue Jun 14, 2024 · 1 comment
Assignees
Labels
enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment! learn Learn this! priority-1 Highest priority issue. This is costing us money every minute that passes. T4h Time Estimate 4 Hours technical A technical issue that requires understanding of the code, infrastructure or dependencies

Comments

@nelsonic
Copy link
Member

nelsonic commented Jun 14, 2024

We need to build a Documentation Website that has:

  1. Fast page load times - e.g. via server-side rendering or static pages.
  2. Authentication - so we can protect certain pages.
  3. Full-text Search - so people can find what they are looking for when there are many pages.

We are going to use the nextra https://nextra.site framework for building this site.

Todo

  • Create a new project/repo: https://github.com/dwyl/nextra-demo (will be public soon ...)
  • Create a brand new nextra project in it.
  • Document all the steps you take for creating the project; no step is too small.
  • Add authentication: OAuth2 via: https://nextjs.org/docs/app/building-your-application/authentication
    (if you get stuck, comment on this issue for help!)
  • Add some basic content to the site 3-5 pages is enough. Can be about any topic you like; Kittens, Boats, Chocolate, BTC, doesn't matter.
  • Protect 2 of the pages using auth i.e. should 404 if the person is not authenticated but display if they are.
    • Document how this is done.
  • Enable search.
    • Search should only surface the public pages if the person is not authenticated.
    • Should show the private pages if the person has logged in.
  • Tests! 🧪 we need decent (preferably 100%) test coverage on this demo. 💯
  • Analytics 📈 📊 Deploy Plausible Analytics to a VPS 📈 📊 🚀 + Document it! 📝  learn-analytics#3
@nelsonic nelsonic changed the title Todo: Explore Using Nextra Task: Explore Using Nextra For Building a Documentation Site with Search and Auth Jun 17, 2024
@nelsonic nelsonic changed the title Task: Explore Using Nextra For Building a Documentation Site with Search and Auth Task: Explore Using Nextra for Docs Site with Search + Auth Jun 17, 2024
@nelsonic nelsonic added enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment! technical A technical issue that requires understanding of the code, infrastructure or dependencies T4h Time Estimate 4 Hours learn Learn this! priority-1 Highest priority issue. This is costing us money every minute that passes. labels Jun 17, 2024
@LuchoTurtle LuchoTurtle transferred this issue from dwyl/learn-nextjs Jun 20, 2024
nelsonic added a commit that referenced this issue Jul 16, 2024
nelsonic added a commit that referenced this issue Jul 16, 2024
nelsonic added a commit that referenced this issue Jul 16, 2024
@nelsonic
Copy link
Member Author

Open Question on Plausible Analytics in Nextra: shuding/nextra#3047

@github-project-automation github-project-automation bot moved this to More ToDo ThanCanEver Be Done in Nelson's List Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment! learn Learn this! priority-1 Highest priority issue. This is costing us money every minute that passes. T4h Time Estimate 4 Hours technical A technical issue that requires understanding of the code, infrastructure or dependencies
Projects
Status: More ToDo ThanCanEver Be Done
Development

No branches or pull requests

2 participants