XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to...
Transcript of XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to...
![Page 2: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/2.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
It’s services all the way down! We use a lot of services, connected to provide
solutions: • Storage • Versioning • Publishing • Integration • Communication
Let’s add XaaS - XML Authoring as a Service
![Page 3: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/3.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Use cases Everyone can contribute! Documentation updates by technical support team Involve developers to review documentation
![Page 4: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/4.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Everyone can contribute!
![Page 5: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/5.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
The DITA-OT documentation http://www.dita-ot/dev
![Page 6: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/6.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Connected services
GitHub
GitHub Pages • www.dita-ot.org
Travis publish scripts
Slack
docs DITA source
dita-ot.github.io Generated website
Services used by the DITA-OT documentation:
• GitHub
• GitHub Pages
• Travis
• Slack
![Page 7: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/7.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Connected services
GitHub
GitHub Pages • www.dita-ot.org
Travis publish scripts
Slack
docs DITA source
dita-ot.github.io Generated website
XML Authoring?
![Page 8: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/8.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Desktop editor
GitHub contribution workflow original remote repository dita-ot/docs
your remote repository
1. fork
your local repository branch
2. clone
Working copy
3. checkout
4. change
5. commit
6. push
7. pull request
Edited File
GitHub
Local
![Page 9: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/9.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Desktop editor
GitHub contribution workflow your remote repository
1. fork
your local repository branch
2. clone
Working copy
3. checkout
4. change
5. commit
6. push
7. pull request
Edited File
GitHub
Local
original remote repository dita-ot/docs
![Page 10: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/10.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Simplified GitHub workflow
From
• Fork remote • Clone locally • Branch • Checkout working copy • Change • Commit locally • Push to remote • Send pull request
To
• Change
• Save/Commit
Automate parts of the contribution workflow
![Page 11: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/11.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Simplified workflow
original remote repository
Edited File
1. change
2. save à fork + commit/push + pull request
![Page 12: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/12.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
New service: XML Authoring Services used by the DITA-OT documentation: • GitHub
• storage • versioning • access control • issue tracking
• GitHub Pages • web publishing
• Travis • automate publishing
• Slack • project communication
• oXygen XML Web Author • web-based XML Authoring
![Page 13: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/13.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Connected services
GitHub
GitHub Pages • www.dita-ot.org
Travis publish scripts
Slack
docs DITA source
dita-ot.github.io Generated website oXygen XML
Web Author
![Page 14: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/14.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Click on website to edit its content
![Page 15: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/15.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
DITA-OT documentation website
edit link
http://www.dita-ot.org/dev/
![Page 16: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/16.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Edit the source content
![Page 17: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/17.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Save to send a request for change
![Page 18: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/18.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
xproc.org and exproc.org http://xproc.org
http://exproc.org Connected services
• GitHub • GitHub Pages • Travis • oXygen XML Web Author
This time the source is DocBook
![Page 19: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/19.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
xproc.org
edit link
![Page 20: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/20.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
xproc.org source
![Page 21: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/21.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
DITA-based Wiki http://www.github.com/georgebina/ghd-wiki
Connected services • GitHub • GitHub Pages • Travis (using oXygen XML WebHelp for publishing) • oXygen XML Web Author
Source in DITA / Lightweight DITA / Markdown
![Page 22: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/22.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Lightweight DITA topic
History and Edit links
![Page 23: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/23.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Revisions history
![Page 24: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/24.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Controlled AX online editor
![Page 25: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/25.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Documentation updates by technical support team
![Page 26: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/26.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
The oXygen XML Editor user guide https://oxygenxml.com/doc/versions/18.1/ug-editor/
Allow technical support engineers to propose
documentation fixes or improvements
![Page 27: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/27.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Links to edit each topic
![Page 28: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/28.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Involve developers to review product documentation
![Page 29: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/29.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Review product documentation Connected services:
• GitHub • Jira • oXygen XML Web Author
![Page 30: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/30.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Link to changed topics
click to review/edit
![Page 31: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/31.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Email notifications with links
![Page 32: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/32.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Take-aways XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be
easier! Click – Edit – Save – Describe what you changed Anyone can edit the content by following a link Contributions can be reviewed before they are published
(content curation) A customized user interface can lower the entry barrier for
non-technical users We need more services - diff, publishing, etc.
![Page 33: XML Authoring as a Service - XaaS · XaaS – XML (Authoring) as a Service Contributing content to XML-based systems cannot be easier! Click – Edit – Save – Describe what you](https://reader035.fdocuments.in/reader035/viewer/2022071218/60520715d631682a95212d54/html5/thumbnails/33.jpg)
@georgebina #xmlprague Copyright @ Syncro Soft, 2017. All rights reserved.
XML Authoring as a Service
Thank you!
Questions? [email protected] @georgebina http://www.oxygenxml.com