Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 0.6
    • Fix Version/s: 0.7
    • Labels:
      None

      Description

      >Hello devs,
      >> Stephan Schlierf posted me a HowTo about tab specific PDF as a XML-doc.12.
      >>
      >> Now my question is where should I put it into the documentation?
      >> So far I could not find any place in our site for HowTos.


      We used to have a section called Community with HowTos
      but that was deliberately hidden in the re-organisation
      to /docs/ ... most of those were demonstration docs.

      Now that we have a real one we can bring them back.

      Adding them to the Documentation tab will get cumbersome
      when we have more of them. So how about adding another
      tab called HowTo which lists the stuff that is in /docs/howto/

        Issue Links

          Activity

          Hide
          Thorsten Scherler added a comment -
          Please conduct discussion and contributions on the mailing
          lists or via the issue tracker. Sending contributions and
          discussion privately to committers is discouraged, as it is
          not sustainable and can lead to many unpleasant issues.
          Show
          Thorsten Scherler added a comment - Please conduct discussion and contributions on the mailing lists or via the issue tracker. Sending contributions and discussion privately to committers is discouraged, as it is not sustainable and can lead to many unpleasant issues.
          Hide
          Thorsten Scherler added a comment -
          I promised Stephan that we will proofread the how to before we will publish it!
          Show
          Thorsten Scherler added a comment - I promised Stephan that we will proofread the how to before we will publish it!
          Hide
          David Crossley added a comment -
          I have done a quick review and do not see any reason why it cannot be committed. We can enhance it once it is in.

          However, there is one thing that does need to be changed. We do not specify authors of documents. The contributor is acknowledged in the status.xml changes file and in the commit log.

          Perhaps CDATA would be better in the "source" elements to protect the pointy brackets and preserve space.
          Show
          David Crossley added a comment - I have done a quick review and do not see any reason why it cannot be committed. We can enhance it once it is in. However, there is one thing that does need to be changed. We do not specify authors of documents. The contributor is acknowledged in the status.xml changes file and in the commit log. Perhaps CDATA would be better in the "source" elements to protect the pointy brackets and preserve space.
          Hide
          Thorsten Scherler added a comment -
          http://marc.theaimsgroup.com/?t=109502171400002&r=1&w=2

          We cannot have custom sitemaps like described in above mentioned thread.

          We have to rewrite the howto to meet the actual situation.
          Show
          Thorsten Scherler added a comment - http://marc.theaimsgroup.com/?t=109502171400002&r=1&w=2 We cannot have custom sitemaps like described in above mentioned thread. We have to rewrite the howto to meet the actual situation.
          Hide
          Nicola Ken Barozzi added a comment -
          This can be done for 0.6, but will not hold off a 0.6 release.
          Show
          Nicola Ken Barozzi added a comment - This can be done for 0.6, but will not hold off a 0.6 release.
          Hide
          Thorsten Scherler added a comment -
          The howto is updated.

          NOTE:
          Do not use directories with "."? in it. Replace them by "_"!
          e.g 1.2/ will not work in the aggregation. e.g. 1_2/ just works fine.
          Show
          Thorsten Scherler added a comment - The howto is updated. NOTE: Do not use directories with "."? in it. Replace them by "_"! e.g 1.2/ will not work in the aggregation. e.g. 1_2/ just works fine.

            People

            • Assignee:
              Thorsten Scherler
              Reporter:
              Thorsten Scherler
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development