generator-jhipster
generator-jhipster copied to clipboard
jhipster
jhipster.github.io website design update
Overview of the feature request
This is concerning https://github.com/jhipster/jhipster.github.io
With @ascelineboullen we propose our contribution to update and refresh jHipster's website design.
In first @ascelineboullen can create wireframes / sketch on Figma to see future design and use it as a support of discussion.
We also propose to use new technologies for website development :
- NextJs for using React (to have components approach)
- Chakra UI as UI library for components and layout (give composable approach and it's very simple to use)
A big +1 from me
I think the difficulty part would be:
- keep MD files to update content
- keep a way to test content before submitting pull request
If the technology has not yet been defined, I suggest you take a look at the Hugo it is written in go, it's simple, and according to its description it is "The world’s fastest framework for building websites."
I use hugo for my personal blog and really like it as it also supports asciidoc(tor) as alternative to markdown. Before do anything we should maybe think about how to structure should be eventually. Maybe we also can make the separation between high level (marketing) overview and user documentation more clear.
Yes a site revamp is heavily needed and appreciated. Few things to keep in mind (some pointers from my experience doing the last revamp)
- We are hosted on GitHub pages that means the site needs to be Jekyll based else things will become much more difficult like having CIs that can build and publish that static content on each commit. I don't think it's a big deal but its additional work to be considered and makes deployment a bit more complex than today
- The markdown content needs to remain the same, which means the framework (gatsby, Hugo or whatever should be able to work with existing markdown files)
- Our markdown files use front matter for metadata and stuff like url redirect etc, this behaviours need to be retained, last I checked Gatsby and Hugo doesn't support front matter, but things might have changed
- There are parts of the site that uses AngularJS like home page, marketplace etc, these need to be migrated, it shouldn't be a big deal IMO
- The URL slugs should not change, this is very very important as it affects our SEO (file structure can change as long as URL slug remains the same, with Jekyll its possible with front matter not sure about others)
IMO the best way to approach this would be
- Redesign the site CSS first
- Move dynamic pages from Angular to React or Vue
- Move to new SSG (Gatsby or Hugo or whatever) personally I don't care much for this step as Jekyll is still good for our usecase
Thanks a lot for offering contributions to the design !
Having managed some aspects of the website over the years (docs archive, chinese i18n, microservice docs...). Here are my suggestion for the website:
- Support Markdown for documentation pages. The Markdown format is the most simple to maximize ease of contributions so we need to keep it. However this is only for the documentation part, the landing page and some other specific pages could use other formats.
- Use a static site generator (no back-end) and host in GitHub pages. On the contrary to Deepu, I would be OK to move away from Jekyll as they are a lot of other tools which are easy to setup with GitHub Action. However we really don't want to have a back-end as we have a lot of traffic from all over the world (really impressive) and don't want to pay for servers or have the website be slow for users located in far away regions.
- Support an archive of old versions of the website (like I did for https://www.jhipster.tech/documentation-archive/)
- Support multiple languages. As of right now we have english and chinese language website (https://jhipster.tech/cn) but it's not really an optimal setup as the Chinese website is a fork of the English version.
- Make the doc pages look more standard. Typical tech doc pages looks like https://docs.readthedocs.io/ or https://docs.gitbook.com/. This is what we should have.
One great "framework" that fit all requirements is https://docusaurus.io/ . It is developed by the React team for their docs so I guess it could be a good base for the new website on top of which could be developed great looking design.
Hello, thanks all for your responses
- Yes we will keep markdown files for content. With Next JS there is no problem for that : https://nextjs.org/blog/markdown
- Yes it will be only a front-end project, no back-end is needed I think for the website
- We will keep current URLs / slugs for all pages for SEO and archived websites
- For languages, we will setup an internationalization system with NextJs
For now in first step, I think that we should start by designing the new website with some wireframes and then we'll go back to stack issues
For now in first step, I think that we should start by designing the new website with some wireframes and then we'll go back to stack issues
Yes plz, small steps to have quick feedbacks first :)
Hello everyone, with @ascelineboullen we started to think about new pages and links disposition. In first, we think that some generator informations or some tools like Jhipster online generator or JDL Studio are not highlighted enough.
We'll have more time to work on it this month. We'll go back soon with some propositions to discuss with you :)
Totally agree on that! Thanks a lot for your work on this, we have a ton of visitors (110,000 unique visitors last month) and it’s going to help a lot of people.
Thats a great point. i added JDL studio to main menu for now. But agree we need a proper redesign
On Sun, 7 Feb 2021, 7:04 am Julien Dubois, [email protected] wrote:
Totally agree on that! Thanks a lot for your work on this, we have a ton of visitors (110,000 unique visitors last month) and it’s going to help a lot of people.
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jhipster/generator-jhipster/issues/13595#issuecomment-774608917, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIOKF2B2SBKWT6TCXBPRWLS5YUOVANCNFSM4WHWN7WA .
This issue is stale because it has been open 30 days with no activity. Our core developers tend to be more verbose on denying. If there is no negative comment, possibly this feature will be accepted. We are accepting PRs :smiley:. Comment or this will be closed in 7 days
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
This issue is stale because it has been open 30 days with no activity. Our core developers tend to be more verbose on denying. If there is no negative comment, possibly this feature will be accepted. We are accepting PRs :smiley:. Comment or this will be closed in 7 days
I have a contact that's developing a website for us at @oktadev. I could ask them for a quote to redesign our site too. While we're add it, we should fix our vulnerabilities. I tested Snyk's new website scanner and we get an F.
We could at least have a new CSS, and also a custom one for the generated apps (not sure if that can work across all front-end frameworks). But having a common visual identity would be awesome. Concerning Snyk, as the website is a static website, I wonder how we can have XSS attacks - how are those supposed to work? Anyway, we have money and this is the kind of thing we need to pay for, so yes @mraible if you can get a quote that's very interesting.
Hello @mraible @jdubois, @ascelineboullen is preparing some sketchs for the jHipster website, we'll be able to show you this next week I think. This can be a base for a reflexion about the website reorganization and it will give some ideas about the update of the design
Concerning Snyk, as the website is a static website, I wonder how we can have XSS attacks - how are those supposed to work?
Google.com gets a "D" on Snyk... just for reference.
@ascelineboullen did a first version of wireframes for the website design update : https://rebrand.ly/jhipster ! There are still some parts in progress, but you can start to send us feedbacks on the reorganization and on the design choices :)
Home page looks great. We need to move the sponsor section up though
On Wed, 19 May 2021, 8:30 am ntorionbearstudio, @.***> wrote:
@ascelineboullen https://github.com/ascelineboullen did a first version of wireframes for the website design update : https://rebrand.ly/jhipster ! There are still some parts in progress, but you can start to send us feedbacks on the reorganization and on the design choices :)
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jhipster/generator-jhipster/issues/13595#issuecomment-843786240, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIOKFZAK4WOWT6VK4DZ7TTTONLHTANCNFSM4WHWN7WA .
@ntorionbearstudio I ❤️ it! It looks fantastic. Do you plan to offer light and dark options?
Yes @ntorionbearstudio this looks awesome! I especially like the docs, this really needs to be improved.
This issue is stale because it has been open 30 days with no activity. Our core developers tend to be more verbose on denying. If there is no negative comment, possibly this feature will be accepted. We are accepting PRs :smiley:. Comment or this will be closed in 7 days
This issue is stale because it has been open 30 days with no activity. Our core developers tend to be more verbose on denying. If there is no negative comment, possibly this feature will be accepted. We are accepting PRs :smiley:. Comment or this will be closed in 7 days
This issue is stale because it has been open 30 days with no activity. Our core developers tend to be more verbose on denying. If there is no negative comment, possibly this feature will be accepted. We are accepting PRs :smiley:. Comment or this will be closed in 7 days
@dogeared recommended we take a look at livecycle.io:
Livecycle is building this super cool collaboration service where devs and non-devs alike can work on projects. For instance, someone who spots a typo or a sentence that could use some wordsmithing or a section of the site that could use better formatting, but isn't a developer could make a suggestion on a live version of the site. That would then provide instant feedback to someone responsible for making the updates on the github repo. (You can see a video clip of this in action on the https://livecycle.io site).
Maybe it can help us when re-designing our website?