The Wayback Machine - https://web.archive.org/web/20201125092407/https://github.com/verdaccio/verdaccio/issues/1862
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: website with GatsbyJS #1862

Open
juanpicado opened this issue Jun 24, 2020 · 0 comments
Open

feat: website with GatsbyJS #1862

juanpicado opened this issue Jun 24, 2020 · 0 comments

Comments

@juanpicado
Copy link
Member

@juanpicado juanpicado commented Jun 24, 2020

This is the first try using GatsbyJS as website:

Goals

  • To have a more flexible website
  • Be able to add new pages based on different sources (GitHub, Markdown, etc etc)
  • Improve SEO experience
  • Custom versioning (nice to have): We don't want to build versioning for each change, versioning should be immutable. Eg: If we are on v5.0.0 and we release a patch version, the v5.0.0 will pass a subfolder in the CDN and we do no to have to build it again, the master would be the one is under the root domain. This reduce the amount of MB we need to upload to the CDN every time we do a release.
  • Translations, with Crowdin we can fetch all translations on CI and build the website, we don't want to merge big PR every time someone change something on the crowdin platform.
  • Custom design verdaccio/website#75 (comment)

❤️ help is very welcome, otherwise it will take a while 😊

This is only for 5.x branch

In reference to verdaccio/website#248

Development

pnpm install
cd website
pnpm develop

Then http://localhost:3000

Gatsby.js documentation applies to this website.

Tasks

Each task might be a new PR on top of this branch feat-website

  • Integrate with crowdin (currently I copied some translations to make it work): Translations should be downloaded in compile time, unpackage them and generate all pages.
  • Restore auto deployment to the CDN (already works here https://github.com/verdaccio/website_2.0)
  • Mobile ready (should be easy to navigate on mobile)
  • Create layout (layout for mobile and desktop
  • Improve navigation (navigation, switch languages, forward and backwards according the sidebar navigation)
  • Create design (there is one proposal already)
  • Create doc pages
  • Create scaffolding with GatsbyJS #1843

⚠️ If you want to just PR something small, any typo, linting, new TS type or micro change is very welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Verdaccio 5
  
In progress
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.