Updates: need doc reviews, Docker changes, beta release of 2.3.0

"John P. Rouillard" <[email protected]>
Newsgroups gmane.comp.bug-tracking.roundup.user
Message-ID <[email protected]>
Hello all:

As I close in on the 2.3.0 release, I need some help.

For the docker people, I just committed some new capabilities. Docker
can now be used to run:

  * demo mode
  * roundup-admin
  * a shell (so regular manual mode configuration can be done)

these need testing. The demo mode, and setting up a tracker using the
manual directions with the shell or admin mode work for me in light
testing, but they need more.

See the enhanced docs at:

   https://www.roundup-tracker.org/dev_docs/docs/installation.html#running-in-demo-mode-with-docker

   https://www.roundup-tracker.org/dev_docs/docs/installation.html#docker-support

Speaking of enhanced docs, I have done some restructuring, cleanup and
re-styling of the docs. There is one more major change to come before
release:

   Moving the top of customizing.html to a separate reference.html doc.

Everything on that page before the Examples section will be moved.  I
am trying to rework the docs according to the diataxis
(https://diataxis.fr/) framework. I can use help with this. If anybody
has friends who are into documentation (tech writers for example) who
would like to help out I would appreciate it if you mention this to
them.

I have also overhauled the styles for the docs.  I have gotten
feedback from a few of people that the docs are a "wall of text",
"unusable", and "looks old" which drive away possible users. I hope
some of the re-design and change to diataxis will help people discover
the information they need to run Roundup more easily and give them the
confidence to use it.

Please provide feedback on the look and feel of the new docs. Compare
the new look:

  https://www.roundup-tracker.org/dev_docs/

to the current:

  https://www.roundup-tracker.org/

The goal is to increase use of Roundup by making the docs more
readable and scanable.

  * white space has been added to increase scan-ability and tie headers
    and terms closer to their related material.

  * header sizes have been changed as well for scan-ability.

  * examples should fit the page and provide hints that they are scrollable.

  * the doc experience should be much improved on mobile devices.

  * moved older docs out of the left sidebar to a subpage. This is 
    an attempt to reduce clutter and intimidation factor of a long list.

Please try to use the new docs and provide feedback.

Also if anybody wants to take either the postgres full text search or
sqlite full text search features for a spin, I would appreciate it.

Full set of changes is at:

   https://sourceforge.net/p/roundup/code/ci/default/tree/CHANGES.txt

I plan on a 2.3.0 beta release no (alpha this time) at the start of
June. The 2.3.0 release is scheduled for 13 July.

Have a great week everybody.

--
				-- rouilj
John Rouillard
===========================================================================
My employers don't acknowledge my existence much less my opinions.
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.