• Icon: Sub-task Sub-task
    • Resolution: Fixed
    • Icon: L3 - Default L3 - Default
    • 2.0.0
    • None
    • documentation
    • None

      AT:

      • in the footer section of the user guide, I can read about:
        • what kind of state the engine connection status has and what each state means
        • how I can see the import progress of the engine
        • the states of the elasticsearch connection status
        • small images of the possible footer states
        • I can see the Optimize version

        This is the controller panel for Smart Panels app

            [OPT-1164] Document the footer

            Johannes added a comment -

            Review hint:

            • this is my bad, because I told you wrong: in the user guide file structure we should create a subdirectory footer and rename the footer.md to index.md. Analogous to how it is done in the analysis section. There, you could also put your images.
            • the images don't have the correct size. The docs screenshot guide on how to create proper screenshots.
            • Import progress bullet point: we shouldn't have a single subitem bullet point, because bullet points always indicate a list. However, here we don't really have a list. Why not just have colon after each item and then describe what they mean, like:
              • Engine connections status: for each engine that is connected to Optimize the connection status is shown. Thus, you are immediately aware if there is something wrong with the engine and new data can be imported at all.
              • Import progress: indicates if Optimize is currently importing data from the engine and the amount that was already imported. That makes it transparent if we can create reports and perform the analysis on the whole data set or just parts of it.
            • We should also mention that there is once engine connection status for each engine, for instance like I listed in the former point.

            Johannes added a comment - Review hint: this is my bad, because I told you wrong: in the user guide file structure we should create a subdirectory footer and rename the footer.md to index.md. Analogous to how it is done in the analysis section. There, you could also put your images. the images don't have the correct size. The docs screenshot guide on how to create proper screenshots. Import progress bullet point: we shouldn't have a single subitem bullet point, because bullet points always indicate a list. However, here we don't really have a list. Why not just have colon after each item and then describe what they mean, like: Engine connections status: for each engine that is connected to Optimize the connection status is shown. Thus, you are immediately aware if there is something wrong with the engine and new data can be imported at all. Import progress: indicates if Optimize is currently importing data from the engine and the amount that was already imported. That makes it transparent if we can create reports and perform the analysis on the whole data set or just parts of it. We should also mention that there is once engine connection status for each engine, for instance like I listed in the former point.

              Unassigned Unassigned
              johannes.heinemann Johannes
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Created:
                Updated:
                Resolved: