osgi.enroute.site
osgi.enroute.site copied to clipboard
Modernize site and restructure content
Hi,
first of all: I really like the OSGi enRoute. It's a great piece of work and I often come to the site for getting information about OSGi. The assembled information on this site is really awesome and always helpful.
BUT: The content seems to me being rather fragmented and grown over time with not much structure in mind. Also the look and feel of the site is not what I would expect from an up-to-date project. In my opinion a lot more users could be attracted, if the site had a more modern look and feel and if the content would be better structured.
What I propose:
- Use another Jekyll template for a more modern look and feel. I've set up a sample template here that mimics the look of a lot of modern project sites (or websites in general) today.
- Restructure the content. It would be great to have an overall structure (like a book... I also think this was originally intended, judging from the naming in the source code ) where a visitor easily can see what documentation is provided on this site and also what is still missing. The missing parts would be helpful for contributors to decide which piece of information they want to add and to where help is still needed..
If you agree with the above named points I would start to set up the OSGi enRoute site with the new template on my fork, so that you can see how it would look like. Also, I would create a table of contents for the site to show how I would restructure the content. If you agree on this TOC I would then step by step port the site to this new structure.
I know that my proposal is a rather disruptive change, so please do not take offense. It is done with best intentions. I just think, that OSGi and OSGi enRoute are not yet receiving the attention they deserve and that a more modern appearance and a better structure would help to attract more user.
Kind regards, Thomas
I think this is a wonderful proposal. And I would support it.
I could help review the design and give suggestions.
On Sep 30, 2017 09:35, "Sandared" [email protected] wrote:
Hi,
first of all: I really like the OSGi enRoute. It's a great piece of work and I often come to the site for getting information about OSGi. The assembled information on this site is really awesome and always helpful.
BUT: The content seems to me being rather fragmented and grown over time with not much structure in mind. Also the look and feel of the site is not what I would expect from an up-to-date project. In my opinion a lot more users could be attracted, if the site had a more modern look and feel and if the content would be better structured.
What I propose:
- Use another Jekyll template for a more modern look and feel. I've set up a sample template here https://sandared.github.io/documentation_template/ that mimics the look of a lot of modern project sites (or websites in general) today.
- Restructure the content. It would be great to have an overall structure (like a book... I also think this was originally intended, judging from the naming in the source code ) where a visitor easily can see what documentation is provided on this site and also what is still missing. The missing parts would be helpful for contributors to decide which piece of information they want to add and to where help is still needed..
If you agree with the above named points I would start to set up the OSGi enRoute site with the new template on my fork, so that you can see how it would look like. Also, I would create a table of contents for the site to show how I would restructure the content. If you agree on this TOC I would then step by step port the site to this new structure.
I know that my proposal is a rather disruptive change, so please do not take offense. It is done with best intentions. I just think, that OSGi and OSGi enRoute are not yet receiving the attention they deserve and that a more modern appearance and a better structure would help to attract more user.
Kind regards, Thomas
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/osgi/osgi.enroute.site/issues/136, or mute the thread https://github.com/notifications/unsubscribe-auth/AAI9THOQqm6oSqmVYQR3U-akbrhVRnxWks5snkOogaJpZM4Ppj55 .
Hi Raymond,
thanks a lot for the support! Just to provide everyone a better insight on how this might look in the end, I will set up a MWE until next Monday.
After that I'm on vacation until the end of October. So there's enough time for discussion IF and (if yes) how it should be done.
If all the maintainers of this site agree, I would start working on this topic in November.
Kind regards, Thomas
Hi,
as there were no comments on the MWE I started to port the content of the site to the new layout. Today I've ported the Quick Start Tutorial. I have not checked all links but images should be fine by now.
Please have a look at it and tell me if something does not fit your needs.
I will continue to port the content in the next weeks.
Kind regards, Thomas
The base tutorial has been moved now: https://sandared.github.io/enroutemwe/documentation/tutorials.html
Kind regards, Thomas
Hi,
all tutorials and services have been moved now. See https://sandared.github.io/enroutemwe/
Any comments yet? @rotty3000 ?
Kind regards, Thomas