Proposed HTML Documentation Styles
Hi, As part of the effort to modernize the look and feel of PostgreSQL.org and associated web projects, Sarah & I have worked on applying the new styles to the documentation. The main goals of the project were: - To have the documentation styles match that of the main website - To make the documentation easier to view on mobile devices - To set up the web-based documentation for future usability changes and improvements Other than reversing how the versions are display at the top of the website, we did not change any of the documentation structure and do not intend to as part of this version of the project. We have created a prototype of the new styles that can be viewed here, with the credentials below: http://174.138.60.30/docs/ pgdocs / newstyles When browsing through this site, please note: - All interactions are confined to the "/docs" folder - Not all of the docs are loaded and they are not all the latest versions - this is just for beta testing purposes - Search in the prototype does not work We are looking for feedback in the following areas: - Things that may have degraded the user experience, e.g. things that are difficult to read - Visual bugs and errors Our goal is to launch these changes with the upcoming major release, so we appreciate your diligence in providing helpful feedback so we can provide the best possible experience. Thanks, Jonathan signature.asc Description: OpenPGP digital signature
Re: Proposed HTML Documentation Styles
čt 4. 10. 2018 v 17:50 odesílatel Jonathan S. Katz napsal: > Hi, > > As part of the effort to modernize the look and feel of PostgreSQL.org > and associated web projects, Sarah & I have worked on applying the new > styles to the documentation. The main goals of the project were: > > - To have the documentation styles match that of the main website > - To make the documentation easier to view on mobile devices > - To set up the web-based documentation for future usability changes and > improvements > > Other than reversing how the versions are display at the top of the > website, we did not change any of the documentation structure and do not > intend to as part of this version of the project. > > We have created a prototype of the new styles that can be viewed here, > with the credentials below: > > http://174.138.60.30/docs/ > pgdocs / newstyles > > When browsing through this site, please note: > > - All interactions are confined to the "/docs" folder > - Not all of the docs are loaded and they are not all the latest > versions - this is just for beta testing purposes > - Search in the prototype does not work > > We are looking for feedback in the following areas: > > - Things that may have degraded the user experience, e.g. things that > are difficult to read > - Visual bugs and errors > When I am going to document, then I see (about 0.5 sec) big PostgreSQL logo. It is not pleasant effect. I don't like table style - middle vertical line is too black Used colour palette is maybe too red based. All my notes are subjective, just my feeling Regards Pavel > Our goal is to launch these changes with the upcoming major release, so > we appreciate your diligence in providing helpful feedback so we can > provide the best possible experience. > > Thanks, > > Jonathan > >
Re: Proposed HTML Documentation Styles
On 2018-Oct-04, Pavel Stehule wrote: > čt 4. 10. 2018 v 17:50 odesílatel Jonathan S. Katz > napsal: > > When I am going to document, then I see (about 0.5 sec) big PostgreSQL > logo. It is not pleasant effect. > > I don't like table style - middle vertical line is too black > > Used colour palette is maybe too red based. Yeah, it's heavily red and I didn't like that very much either, though I can live with it if everyone else loves it. This TOC looks a bit odd, with those bold black elements amongst all that red: http://174.138.60.30/docs/10/static/ecpg.html I suppose these should just be bold without changing the color. This page http://174.138.60.30/docs/9.4/static/libpq-connect.html has some keywords inside "Warning" and "Note" boxes. Those keywords acquire a gray background instead of inheriting the background color of the box, as in the original stylesheets. Really odd-looking. Cheers -- Álvaro Herrerahttps://www.2ndQuadrant.com/ PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
Re: Proposed HTML Documentation Styles
Hi Pavel, On 10/4/18 12:02 PM, Pavel Stehule wrote: > When I am going to document, then I see (about 0.5 sec) big PostgreSQL > logo. It is not pleasant effect. That's cache related - we won't need to worry about that on the production site. > > I don't like table style - middle vertical line is too black > > Used colour palette is maybe too red based. > > All my notes are subjective, just my feeling Thanks for your feedback! Jonathan signature.asc Description: OpenPGP digital signature
Re: Proposed HTML Documentation Styles
On 10/4/18 12:28 PM, Alvaro Herrera wrote: > On 2018-Oct-04, Pavel Stehule wrote: > >> čt 4. 10. 2018 v 17:50 odesílatel Jonathan S. Katz >> napsal: >> >> When I am going to document, then I see (about 0.5 sec) big PostgreSQL >> logo. It is not pleasant effect. >> >> I don't like table style - middle vertical line is too black >> >> Used colour palette is maybe too red based. > > Yeah, it's heavily red and I didn't like that very much either, though I > can live with it if everyone else loves it. We can always see if we can find something more palatable. In some earlier testing there were some issues with the blue, but perhaps there are some better ways to achieve the proper PostgreSQL color palette. > > This TOC looks a bit odd, with those bold black elements amongst all > that red: http://174.138.60.30/docs/10/static/ecpg.html I suppose these > should just be bold without changing the color. > > This page http://174.138.60.30/docs/9.4/static/libpq-connect.html > has some keywords inside "Warning" and "Note" boxes. Those keywords > acquire a gray background instead of inheriting the background color of > the box, as in the original stylesheets. Really odd-looking. Thanks - both of the above have been noted and will be fixed. Jonathan signature.asc Description: OpenPGP digital signature
Re: Proposed HTML Documentation Styles
> On 4 Oct 2018, at 18:33, Jonathan S. Katz wrote: > > On 10/4/18 12:28 PM, Alvaro Herrera wrote: >> This page http://174.138.60.30/docs/9.4/static/libpq-connect.html >> has some keywords inside "Warning" and "Note" boxes. Those keywords >> acquire a gray background instead of inheriting the background color of >> the box, as in the original stylesheets. Really odd-looking. > > Thanks - both of the above have been noted and will be fixed. Not sure if it’s the same thing, but code blocks on Tip boxes no longer have a separate background color - only an outline. There is an example on the below page: http://174.138.60.30/docs/11/static/functions-matching.html cheers ./daniel
Re: Proposed HTML Documentation Styles
On Thu, 4 Oct 2018 at 16:50, Jonathan S. Katz wrote: > As part of the effort to modernize the look and feel of PostgreSQL.org > and associated web projects, Sarah & I have worked on applying the new > styles to the documentation. > > We are looking for feedback in the following areas: > > - Things that may have degraded the user experience, e.g. things that > are difficult to read > - Visual bugs and errors > There seems to be a problem with the layout some of the tables. For example on this page: http://174.138.60.30/docs/10/static/functions-math.html the description column is far too narrow, leading to descriptions with one or two words per line, spread over dozens of lines. Regards, Dean
Re: Proposed HTML Documentation Styles
On 10/4/18 12:33 PM, Jonathan S. Katz wrote: > On 10/4/18 12:28 PM, Alvaro Herrera wrote: >> This TOC looks a bit odd, with those bold black elements amongst all >> that red: http://174.138.60.30/docs/10/static/ecpg.html I suppose these >> should just be bold without changing the color. >> >> This page http://174.138.60.30/docs/9.4/static/libpq-connect.html >> has some keywords inside "Warning" and "Note" boxes. Those keywords >> acquire a gray background instead of inheriting the background color of >> the box, as in the original stylesheets. Really odd-looking. > > Thanks - both of the above have been noted and will be fixed. Updates for this have been pushed to the test website. Thanks for reporting! Jonathan signature.asc Description: OpenPGP digital signature
