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

'Edit this page' link is broken in the init template #6110

Closed
5 of 7 tasks
tinubaby opened this issue Dec 16, 2021 · 4 comments · Fixed by #6119
Closed
5 of 7 tasks

'Edit this page' link is broken in the init template #6110

tinubaby opened this issue Dec 16, 2021 · 4 comments · Fixed by #6119
Labels
bug An error in the Docusaurus core causing instability or issues with its execution closed: working as intended This issue is intended behavior, there's no need to take any action.

Comments

@tinubaby
Copy link

Have you read the Contributing Guidelines on issues?

Prerequisites

  • I'm using the latest version of Docusaurus.
  • I have tried the npm run clear or yarn clear command.
  • I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
  • I have tried creating a repro with https://new.docusaurus.io.
  • I have read the console error message carefully (if applicable).

Description

In https://tutorial.docusaurus.io/docs/intro 'Edit this page' link is not redirecting to the GitHub repo.
In all the pages of docusaurus --> tutorial , the same issue exists.

Steps to reproduce

Step 1: GO to https://tutorial.docusaurus.io/docs/intro
Step 2: Click 'Edit this page'

Expected behavior

Should open the github repo for that page.

Actual behavior

404 Page not found error.

Your environment

  • Public source code:
  • Public site URL:
  • Docusaurus version used:
  • Environment name and version (e.g. Chrome 89, Node.js 16.4):
  • Operating system and version (e.g. Ubuntu 20.04.2 LTS):

Reproducible demo

No response

Self-service

  • I'd be willing to fix this bug myself.
@tinubaby tinubaby added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Dec 16, 2021
@Josh-Cena
Copy link
Collaborator

Please don't assume that the init template is functional in any way. It's only meant for a demo and we have explicitly stated that // please change it to your own demo in the config file.

Could I know where you were pointed to this domain? AFAIK it's not advertised much and we mostly use this template for interactive playgrounds and create-docusaurus

@Josh-Cena Josh-Cena added closed: working as intended This issue is intended behavior, there's no need to take any action. and removed status: needs triage This issue has not been triaged by maintainers labels Dec 16, 2021
@Josh-Cena Josh-Cena changed the title Broken link-'Edit this page' 'Edit this page' link is broken in the init template Dec 16, 2021
@slorber
Copy link
Collaborator

slorber commented Dec 16, 2021

image

The tutorial is browsable online.

It's based on examples/classic deployed to Netlify

Not sure what's the best:

  • find a way to use the create-docusaurus edit URLs?
  • find a way to disable this

Can be a post-step in the generate example script?

@Josh-Cena
Copy link
Collaborator

Josh-Cena commented Dec 16, 2021

What about pointing to the create-docusaurus folder? This has the additional benefit that if the user who just started the init template locally sees anything she would like to update, she can easily do so.

@slorber
Copy link
Collaborator

slorber commented Dec 16, 2021

Yes, that makes sense to me, we could always link to create-docusaurus (online tutorial, init, codesandbox...) so that people would be less confused and be able to edit the tutorial in case of any problem/suggestion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution closed: working as intended This issue is intended behavior, there's no need to take any action.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants