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 homepage bugs #2879

Closed
slorber opened this issue Jun 4, 2020 · 2 comments
Closed

Docs homepage bugs #2879

slorber opened this issue Jun 4, 2020 · 2 comments
Labels
bug An error in the Docusaurus core causing instability or issues with its execution

Comments

@slorber
Copy link
Collaborator

slorber commented Jun 4, 2020

Hi,

This latest PR about docs homepage had some side-effects: #2861

Sites like Watchman have expressed the need to add .html extensions to their docs, this is why we created the slug frontmatter

For example, they want their first doc to be:

The canonical url of such doc should be with html extension as well (as it's the url they had before, and they want to keep it)


Question: it's not clear to me what the behavior should be, if Watchman wants to use this "install" page as docs homepage, yet ensure that the canonical url of the page is, as requested, https://facebook.github.io/watchman/docs/install.html.

It could be safer to have a duplicate index page, with the canonical url being the one requested by the user with the slug option?

We could redirect the /docs root to the canonical page

Or we could forbid the usage of a slug on the document root, considering that the canonical url is always /docs (sites like Watchman wouldn't be able to use document root)


@lex111 to handle the /docs/introduction -> /docs you asked me here, I think we should figure out the final behavior we want first.

@slorber slorber 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 v2 and removed status: needs triage This issue has not been triaged by maintainers labels Jun 4, 2020
@lex111
Copy link
Contributor

lex111 commented Jun 4, 2020

https://v2.docusaurus.io/docs/ has canonical url = https://v2.docusaurus.io/docs/introduction (which does not exist anymore, bad for SEO)

Oh, good catch, this is really bad.

I actually don’t know which option is better. One of our users said that it is better to do without duplicating the page, or to set the canonical url, in the end I did the first one.

@lex111
Copy link
Contributor

lex111 commented Nov 11, 2020

I guess this is no longer a relevant issue, so I will close it.

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
Projects
None yet
Development

No branches or pull requests

2 participants