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

Remove user-focused content #793

Merged
merged 22 commits into from
Nov 4, 2024
Merged

Remove user-focused content #793

merged 22 commits into from
Nov 4, 2024

Conversation

jlwllmr
Copy link
Collaborator

@jlwllmr jlwllmr commented Oct 21, 2024

Removes user-focused (i.e. as opposed to dev-focused) content, including:

  • /users in its entirety. The paths for these files are still present, since they're still required in order to make our external redirect function (mentioned below) function
  • /community, since the hackathon info contained here will be more easily accessible via linea.build

This also includes a lot of tasks that the above changes necessitate:

  • Relocate the glossary to a top-level category
  • Adjust redirects
  • Implement an external redirects function, since the Docusaurus redirects plugin only supports redirects to/from paths within the docs site. This involves: 1) creating a new component RedirectPage.js (under src/components) that lists the necessary redirects and defines a function that acts on those redirects when the relevant path is loaded; 2) Updating the MDX files for the paths we want to redirect from with this component, and commenting out the actual content. A lot of the content has been relocated to the support site.
  • Updates the sidebar
  • Moves some items formerly in the "Contact us" section of the /users sidebar to the footer
  • Amends the navbar

Copy link

vercel bot commented Oct 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
doc-zk-evm ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 9:39am

@mapachurro
Copy link
Collaborator

Builds good, serves good
image

@mapachurro
Copy link
Collaborator

It feels clean, focused on devs. I like it, glad to see the Support domain coming into its own 🦾

@bgravenorst
Copy link
Collaborator

bgravenorst commented Oct 21, 2024

Hi @jlwllmr, regarding:

Implement an external redirects function, since the Docusaurus redirects plugin only supports redirects to/from paths within the docs site. This involves: 1) creating a new component RedirectPage.js (under src/components) that lists the necessary redirects and defines a function that acts on those redirects when the relevant path is loaded; 2) Updating the MDX files for the paths we want to redirect from with this component, and commenting out the actual content. A lot of the content has been relocated to the support site.

I don't think this solution is ideal because search engine crawlers will still pickup the /users folder?
Have you tried a server-side solution? Perhaps updating the vercel.json file with something similar to:

{
  "redirects": [
    {
      "source": "/users",
      "destination": "https://support.linea.build/",
      "permanent": true
    }
  ]
}

See the Vercel docs for more info.

Copy link

vercel bot commented Oct 22, 2024

Deployment failed with the following error:

The `vercel.json` schema validation failed with the following message: `redirects[16].source` should be string

Learn More: https://vercel.com/docs/concepts/projects/project-configuration

@jlwllmr
Copy link
Collaborator Author

jlwllmr commented Oct 22, 2024

Replaced the React component implementation with redirects in the vercel.json file. This involved:

  • Removing the /users directory again
  • Removing it from the sidebar
  • Removing references to these paths from the Docusaurus redirect plugin config

Tested all /users paths in the Vercel preview and they all work smoothly.

@bgravenorst
Copy link
Collaborator

Hey @jlwllmr , what do you think of using this opportunity to move the Run a node content into it’s own section?
Then, since Quickstart and Guides will both be covering developer content, we can call it Develop[ers]/Build.

So then the three headings would be Develop[ers] | Run a node | Architecture

@jlwllmr
Copy link
Collaborator Author

jlwllmr commented Nov 4, 2024

@bgravenorst I think that's a good suggestion, but I'm going to merge this and we can take this discussion into the scope of a future PR

@jlwllmr jlwllmr merged commit 5f62da7 into main Nov 4, 2024
10 checks passed
@jlwllmr jlwllmr deleted the rm-user-content branch November 4, 2024 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants