Uploaded image for project: 'Teiid'
  1. Teiid
  2. TEIID-3871

moving documentation from confluence to gitbook

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 9.0
    • 9.x
    • Documentation
    • None

      From Teiid DV 7 F2F Notes,
      " In the Teiid 9.x timeframe we should look toward moving everything to gitbook / markdown. We should start by migrating the documentation and solicit help with the website if possible."
      This issue will address this.

            [TEIID-3871] moving documentation from confluence to gitbook

            Steven, I have added, https://www.gitbook.com/book/teiid/documents/details are mapped with teiid/teiid-documents.

            Kylin Soong (Inactive) added a comment - Steven, I have added, https://www.gitbook.com/book/teiid/documents/details are mapped with teiid/teiid-documents.

            Kylin can you add me to teiid.gitbooks.io and we need to get the site pointed over to teiid/teiid-documents as it still seems to be feed off of teiiddocs - https://www.gitbook.com/book/teiid/reference-guide/details

            Steven Hawkins added a comment - Kylin can you add me to teiid.gitbooks.io and we need to get the site pointed over to teiid/teiid-documents as it still seems to be feed off of teiiddocs - https://www.gitbook.com/book/teiid/reference-guide/details

            So far, for https://teiid.gitbooks.io/documents/content/index.html there still have 2 aspect works left:

            Fix the link

            There are lot of pages have link point to conference pages that need to fixed, some pages have internal link that not work. Steven have created a Sub-task for addressing this.

            Polish the UI

            The UI not so user-friendly, at least, navigation tree should add expand and collapse ability. But from F2F notes, teiid document will add to teiid's website, so I think the polish UI work should let the website developer do, we only need to provide html/pdf/epub each time a new version released.

            Kylin Soong (Inactive) added a comment - So far, for https://teiid.gitbooks.io/documents/content/index.html there still have 2 aspect works left: Fix the link There are lot of pages have link point to conference pages that need to fixed, some pages have internal link that not work. Steven have created a Sub-task for addressing this. Polish the UI The UI not so user-friendly, at least, navigation tree should add expand and collapse ability. But from F2F notes, teiid document will add to teiid's website, so I think the polish UI work should let the website developer do, we only need to provide html/pdf/epub each time a new version released.

            Kylin Soong (Inactive) added a comment - - edited

            >Do you know off hand what needs to be done for the subpages like the ones under https://teiid.gitbooks.io/reference-guide/content/reference/Scalar_Functions.html to show up?
            The reason https://teiid.gitbooks.io/reference-guide/content/reference/Scalar_Functions.html not show up is some content not submitted, now it works.
            [1] is a draft which I used in migration, Due to we have created [2], so I think [2] is the place which hold the content, and future update/maintenance should base on.
            [1] https://github.com/teiiddoc
            [2] https://github.com/teiid/teiid-documents/
            >Also the general link https://teiid.gitbooks.io/documents/content seems to provide dead links, is that expected?
            If you append a slash or slash with index.html, for example

            it will works, probably some more investigation can find root cause.What I have considered is we should custom domain, as [3], we can buy a domain(eg,doc.teiid.org), then replace default https://teiid.gitbooks.io/documents/content/, what's about your think?
            [3] http://help.gitbook.com/platform/domains.html

            Kylin Soong (Inactive) added a comment - - edited >Do you know off hand what needs to be done for the subpages like the ones under https://teiid.gitbooks.io/reference-guide/content/reference/Scalar_Functions.html to show up? The reason https://teiid.gitbooks.io/reference-guide/content/reference/Scalar_Functions.html not show up is some content not submitted, now it works. [1] is a draft which I used in migration, Due to we have created [2] , so I think [2] is the place which hold the content, and future update/maintenance should base on. [1] https://github.com/teiiddoc [2] https://github.com/teiid/teiid-documents/ >Also the general link https://teiid.gitbooks.io/documents/content seems to provide dead links, is that expected? If you append a slash or slash with index.html, for example https://teiid.gitbooks.io/documents/content/ https://teiid.gitbooks.io/documents/content/index.html it will works, probably some more investigation can find root cause.What I have considered is we should custom domain, as [3] , we can buy a domain(eg,doc.teiid.org), then replace default https://teiid.gitbooks.io/documents/content/ , what's about your think? [3] http://help.gitbook.com/platform/domains.html

            Do you know off hand what needs to be done for the subpages like the ones under https://teiid.gitbooks.io/reference-guide/content/reference/Scalar_Functions.html to show up?

            Also the general link https://teiid.gitbooks.io/documents/content seems to provide dead links, is that expected?

            Steven Hawkins added a comment - Do you know off hand what needs to be done for the subpages like the ones under https://teiid.gitbooks.io/reference-guide/content/reference/Scalar_Functions.html to show up? Also the general link https://teiid.gitbooks.io/documents/content seems to provide dead links, is that expected?

            They should all be read only now, thanks.

            Steven Hawkins added a comment - They should all be read only now, thanks.

            rhn-engineering-shawkins, can you set confluence doc(9.0 version [1]) to read only, I have finished migration all of them.

            [1] https://docs.jboss.org/author/display/TEIID/Home

            Kylin Soong (Inactive) added a comment - rhn-engineering-shawkins , can you set confluence doc(9.0 version [1] ) to read only, I have finished migration all of them. [1] https://docs.jboss.org/author/display/TEIID/Home

            rareddy_mk-kafka, thanks, I have added it.

            Kylin Soong (Inactive) added a comment - rareddy_mk-kafka , thanks, I have added it.

            kylinsoong.1214@gmail.comI am not sure what webhook to add, so I gave you admin permission to the repo, so you can add it.

            Ramesh Reddy added a comment - kylinsoong.1214@gmail.com I am not sure what webhook to add, so I gave you admin permission to the repo, so you can add it.

            Kylin Soong (Inactive) added a comment - - edited

            > And to make sure this is from the latest / 9.0 confluence correct?
            Yes. it's base on https://docs.jboss.org/author/display/TEIID/Home.
            > Added https://github.com/teiid/teiid-documents and gave write permissions.
            Seems I am not have enough rights to add Webhook on 'teiid/teiid-documents', currently, gitbook can not catch the Github's update, can you help grant me enough rights, or add [1] as Webhook in 'teiid/teiid-documents'?

            [1] https://git.gitbook.com/github?book=teiid%2Fdocuments&username=kylinsoong&token=87a9a239-70ba-46e0-8fb8-ce877da8279d

            Kylin Soong (Inactive) added a comment - - edited > And to make sure this is from the latest / 9.0 confluence correct? Yes. it's base on https://docs.jboss.org/author/display/TEIID/Home . > Added https://github.com/teiid/teiid-documents and gave write permissions. Seems I am not have enough rights to add Webhook on 'teiid/teiid-documents', currently, gitbook can not catch the Github's update, can you help grant me enough rights, or add [1] as Webhook in 'teiid/teiid-documents'? [1] https://git.gitbook.com/github?book=teiid%2Fdocuments&username=kylinsoong&token=87a9a239-70ba-46e0-8fb8-ce877da8279d

            Added https://github.com/teiid/teiid-documents and gave write permissions.

            Ramesh Reddy added a comment - Added https://github.com/teiid/teiid-documents and gave write permissions.

            Should we have https://github.com/teiiddoc under https://github.com/teiid/teiiddocs so it's part of the master teiid organization?

            I'll also set the docs to read only on confluence when you have them migrated.

            Steven Hawkins added a comment - Should we have https://github.com/teiiddoc under https://github.com/teiid/teiiddocs so it's part of the master teiid organization? I'll also set the docs to read only on confluence when you have them migrated.

            And to make sure this is from the latest / 9.0 confluence correct?

            Steven Hawkins added a comment - And to make sure this is from the latest / 9.0 confluence correct?

            Kylin Soong (Inactive) added a comment - - edited

            Quick Overview

            Quick overview: https://teiid.gitbooks.io/documents/content/index.html

            Sources Content link: https://github.com/teiid/teiid-documents

            Document Migration Status

            Note that: Once a doc in 'Done' status, please update doc via submit to Github, rather than edit Conference pages.

            Kylin Soong (Inactive) added a comment - - edited Quick Overview Quick overview: https://teiid.gitbooks.io/documents/content/index.html Sources Content link: https://github.com/teiid/teiid-documents Document Migration Status Name Status link Embedded Guide Done https://www.gitbook.com/book/teiid/embedded-guide/details Security Guide Done https://www.gitbook.com/book/teiid/security-guide/details Caching Guide Done https://www.gitbook.com/book/teiid/caching-guide/details Administrator's Guide Done https://www.gitbook.com/book/teiid/administrator-s-guide/details Client Developer's Guide Done https://www.gitbook.com/book/teiid/client-developer-guide/details Developer's Guide Done https://www.gitbook.com/book/teiid/developer-s-guide/details Reference Guide Done https://www.gitbook.com/book/teiid/reference-guide/details Note that : Once a doc in ' Done ' status, please update doc via submit to Github, rather than edit Conference pages.

              kylinsoong.1214@gmail.com Kylin Soong (Inactive)
              kylinsoong.1214@gmail.com Kylin Soong (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: