Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.5.0
    • Fix Version/s: 0.5.0
    • Component/s: documentation
    • Labels:
      None

      Description

      Many configuration options are missing from the configuration guide. We should address this before releasing 0.5.0 in order to minimize the user frustration.

      1. WHIRR-310.patch
        18 kB
        Andrei Savu
      2. WHIRR-310-0.5.0.patch
        18 kB
        Andrei Savu
      3. WHIRR-310-0.5.0-standalone-page.patch
        16 kB
        Andrei Savu
      4. WHIRR-310-standalone-page.patch
        16 kB
        Andrei Savu

        Activity

        Hide
        Tom White added a comment -

        I've just committed this. Thanks, Andrei!

        Show
        Tom White added a comment - I've just committed this. Thanks, Andrei!
        Hide
        Andrei Savu added a comment -

        I've created patches for the 0.5.0 branches.

        I still believe the "Whirr in 5 minutes guide" should be on the homepage.

        Show
        Andrei Savu added a comment - I've created patches for the 0.5.0 branches. I still believe the "Whirr in 5 minutes guide" should be on the homepage.
        Hide
        Andrei Savu added a comment -

        I moved the "Whirr in 5 minutes guide" to the About / Home page so that more users could see it. I guess this is more like a matter of personal taste so I will attach a new patch and let you choose.

        Show
        Andrei Savu added a comment - I moved the "Whirr in 5 minutes guide" to the About / Home page so that more users could see it. I guess this is more like a matter of personal taste so I will attach a new patch and let you choose.
        Hide
        Tom White added a comment -

        This looks great. The only thing I wouldn't change is the "whirr in 5 minutes guide". I think it's very useful having it on its own page as users look at the naviagation and see that heading. Burying it in "About" means fewer people will find it. We should prominently link to it from the About page though.

        I agree this change should go in 0.5.0.

        Show
        Tom White added a comment - This looks great. The only thing I wouldn't change is the "whirr in 5 minutes guide". I think it's very useful having it on its own page as users look at the naviagation and see that heading. Burying it in "About" means fewer people will find it. We should prominently link to it from the About page though. I agree this change should go in 0.5.0.
        Hide
        Andrei Savu added a comment -

        In this patch:

        • split the configuration options in multiple groups that are easier to understand
        • checked that all configuration options are documented
        • minor style updates for homepage (whirr & incubator logo)
        • moved the "whirr in 5 minutes" guide to home page (it's small enough and it should allow users to understand easily what Whirr can do)
        • fixed outdated FAQ entries
        • warning message explaining how Whirr is tested

        I believe we should also commit this patch to the 0.5.0 branch.

        Show
        Andrei Savu added a comment - In this patch: split the configuration options in multiple groups that are easier to understand checked that all configuration options are documented minor style updates for homepage (whirr & incubator logo) moved the "whirr in 5 minutes" guide to home page (it's small enough and it should allow users to understand easily what Whirr can do) fixed outdated FAQ entries warning message explaining how Whirr is tested I believe we should also commit this patch to the 0.5.0 branch.

          People

          • Assignee:
            Andrei Savu
            Reporter:
            Andrei Savu
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development