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

feat: new website for mercurius #1

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

Tony133
Copy link

@Tony133 Tony133 commented Sep 16, 2024

  • new website for Mercurius 🔥

issue: mercurius-js/mercurius#1112

@Tony133
Copy link
Author

Tony133 commented Sep 22, 2024

The site to all pages, is complete, pending review , i attach some screenshots here as well here:

site-mecurius-1 site-mecurius-2 site-mecurius-3 site-mecurius-4 site-mercuirus-5

@jonnydgreen
Copy link

This is awesome, I'll have a look and play with it in a bit!

@mcollina
Copy link
Contributor

This is good, however we'd need support for multi-version similar to what Fastify has: https://github.com/fastify/website/blob/main/scripts/download-releases.sh

Copy link

@jonnydgreen jonnydgreen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had a play and looks great!

In addition to the suggestion above around versioning, it might be worth bearing in mind integrating documentation from other plugins - however this is most likely a v2 thing! :)

docusaurus.config.ts Show resolved Hide resolved
docusaurus.config.ts Outdated Show resolved Hide resolved
docusaurus.config.ts Outdated Show resolved Hide resolved
docusaurus.config.ts Outdated Show resolved Hide resolved
docusaurus.config.ts Outdated Show resolved Hide resolved
docusaurus.config.ts Show resolved Hide resolved
@Tony133
Copy link
Author

Tony133 commented Sep 25, 2024

For support for multi-version I succeeded in part, some files give me error ( see screenshot )
screenshot-multi-version

error

If you want I will do the push but it returns some errors maybe it is better to do it in a separate branch after the merge of this PR ?

@mcollina
Copy link
Contributor

You can remove old versions, just keep the last two.

@Tony133
Copy link
Author

Tony133 commented Sep 28, 2024

I have added the following versions of Mercurius ( see screenshots )

  • v13.x
  • v14.x
  • latest
  • Next ( v15.x )

I had to fix some of the titles so they were in line with the other titles in the sidebar and I removed the contributors.md file in the v13.x and v14.x versions otherwise the build would not work.

@mcollina as soon as you have time, let me know If it's okay 🙂

versions-mercurius versions-mercurius-v14

@Tony133
Copy link
Author

Tony133 commented Sep 29, 2024

Do you think it might also be useful to add a button to add a star to the mercurius project and a button to fork the mercurius project ? similar to the Fastify site ? ( see screenshot )

screenshot-button-github

@Tony133
Copy link
Author

Tony133 commented Oct 5, 2024

I added buttons to add a star to the mercurius project and a button to fork the mercurius project. I would say we should be there 💪😉

Copy link

@jonnydgreen jonnydgreen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just played with it locally and I found the following issue:

  • The link in the footer appears to be incorrect?
Screenshot 2024-10-12 at 11 07 15

After looking a little closer, and after running npm run build, I found the following broken links?

[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/hooks.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/api.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-latest/hooks.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-latest/api.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/hooks.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/api.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/typescript.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/hooks.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/hooks.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/api.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-latest/hooks.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/hooks.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-latest/api.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/api.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/typescript.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/hooks.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/api.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/api.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest

Other than that, looks fantastic! :)

docusaurus.config.ts Outdated Show resolved Hide resolved
@Tony133
Copy link
Author

Tony133 commented Oct 12, 2024

Just played with it locally and I found the following issue:

  • The link in the footer appears to be incorrect?
Screenshot 2024-10-12 at 11 07 15 After looking a little closer, and after running `npm run build`, I found the following broken links?
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/hooks.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/api.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-latest/hooks.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-latest/api.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/hooks.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/api.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/typescript.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/hooks.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/hooks.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/api.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.0.x/typescript.md" for version v14.0.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-latest/hooks.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/hooks.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-latest/api.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/api.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/typescript.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/typescript.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (./api/options.md) in source file "REDACTED/website/versioned_docs/version-v14.1.x/hooks.md" for version v14.1.x
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/api.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/examples/graphiql-plugin/README.md) in source file "REDACTED/website/versioned_docs/version-v13.4.x/api.md" for version v13.4.x
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest
[WARNING] Docs markdown link couldn't be resolved: (/docs/integrations/mercurius-integration-testing.md) in source file "REDACTED/website/versioned_docs/version-latest/typescript.md" for version latest

Other than that, looks fantastic! :)

Link fixed see commit here: 8cd1562

Copy link

@jonnydgreen jonnydgreen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Awesome stuff, looking forward to seeing it in action!

@Tony133
Copy link
Author

Tony133 commented Oct 15, 2024

I also made the one for Pino Logger, if you want to have a look at it: pinojs/website#1, very similar to the one by Mercurius, is awaiting review, hoping it will be approved

@mcollina
Copy link
Contributor

I need to catch up on this, sorry :(

@Tony133
Copy link
Author

Tony133 commented Nov 18, 2024

I need to catch up on this, sorry :(

No problem, as soon as you have time 😉

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.

3 participants