xmlservice icon indicating copy to clipboard operation
xmlservice copied to clipboard

Published 20 hours ago • verified publisher icon IBM

Migrate documentation from Yips Wiki to docs

Open kadler opened this issue 6 years ago • 11 comments

The raw wiki content was migrated under b18c3140953690661d07c998e5ea83187bf4d94d and the text version under 140f1ce54e80744099408c0a6b7db0add868d7dd. The docs there need to be converted to understandable documentation and converted to restructured text under the docs directory.

NOTE: Each text file contains the URL to the page it was retrieved from to make it easy to look at the rendered HTML, as it's sometimes useful to see the documentation visually.

The basic structure I have in mind is this:

  • [ ] An intro page with the basics
  • [ ] A page to document the list of actions/tags available with links to each action's documentation
  • [ ] A page/section for each action's documentation
  • [ ] A page describing all the ways you can call XMLSERVICE: CGI, database stored procedures, etc
  • [ ] A page describing the control options and what they do
  • [ ] A page describing what IPC is and why to use it (should be noted that it's quite advanced topic)
  • [ ] A page on error handling (hah!)
  • [ ] A page on pitfalls (numerous)

kadler avatar Jan 23 '19 20:01 kadler

@kadler I will take this. Looks like we need to convert wiki format to html format first and then use Github pagers in the Settings.. 'master branch docs folder'?

Reminders:

  1. add new ctlg flag intro for *ESCP
  2. remove plugconf(x) related info? (need thoughts from @kadler )

jimoibm avatar Apr 04 '19 02:04 jimoibm

@jimoibm @kadler Any updates on documentation for installation? I'd like to be able to get testing going again but I don't have access to the lib installed that contained the *escp fix.

bjeromeHCS avatar Apr 15 '19 19:04 bjeromeHCS

@bjeromeHCS there is an issue #32 that may impact the ouput and we are working on that. Did you install xmlservice with PTFs and cannot could not access the installed QXMLSERV or you meant could not access the source in GitHub?

jimoibm avatar Apr 16 '19 02:04 jimoibm

@jimoibm We installed it from the instructions included with the latest xmlservice.savf from the Yips page, but that's outdated. I'm not sure how to install another way with the source code in this repo.

bjeromeHCS avatar Apr 16 '19 11:04 bjeromeHCS

@bjeromeHCS We discussed about this and will need to have a ccsid issue fixed. Then let you know how to build up xmlservice in Github.

jimoibm avatar Apr 19 '19 01:04 jimoibm

@bjeromeHCS I have updated the README.md with build instructions. There may still be issues with the special character escaping as @jimoibm mentioned.

https://github.com/IBM/xmlservice#building-from-source

kadler avatar Apr 23 '19 18:04 kadler

@kadler Thank you! I will check it out when I can :)

bjeromeHCS avatar Apr 23 '19 18:04 bjeromeHCS

Just wanted to update that it seems the Makefile build worked :+1:

bjeromeHCS avatar Apr 24 '19 17:04 bjeromeHCS

@kadler Do you know if there is a tool to convert the Yips wiki to reStructuredText? It seems Yips wiki is the format of PmWiki. I didn't find a tool that could do the conversion. Guess we have to convert by ourselves?

jimoibm avatar May 08 '19 08:05 jimoibm

@jimoibm I did some searching on various tools and could not get one to convert it so I think we need to hand-convert it. Besides, I think a lot of it needs to be re-worded and re-organized anyway.

kadler avatar May 08 '19 15:05 kadler

@kadler OK. I will try to start with converting each page to RST first. Then work with you on the re-wording and re-organizing.

jimoibm avatar May 09 '19 01:05 jimoibm